YOUR ACCOUNT

Login or Register to post new topics or replies
fisholith
Posts: 24
Filters: 2
If I submit a filter, are there any naming conventions I should be aware of?

Specifically, I plan to submit a 3x3 median filter and a 3x3 percentile (median/max/min) filter I just built to the "Snippet" category.
More information on the filters can be found here:
http://www.filterforge.com/forum/read...ssage80553

There names are presently:
"rls Median 3x3"
"rls Median-Min-Max 3x3"

The "rls" part at the beginning I just use to indicate to myself that they are release versions, because there is no other way to organize your own filters other than by name prefix, (as far as I know).

So, for example, should I remove the "rls" prefix before uploading?,
Should I replace the dashes with spaces before uploading?,
Is it advisable to use a two or three letter author name prefix so that your filters sort to the same place in the filter browser? (It seems to me like that might get in the way, but I don't know. I think I recall seeing a few filter names with that convention.)

Should I submit the above filters at all? As far as I know there are no other existing median algorithms for FF1.

I just figured it would be good to ask before my first submission. smile:)

Any advice or recommendations would be appreciated.
  Details E-Mail
Vladimir Golovin
Administrator
Posts: 3446
Filters: 55
Here are some off the top of my head:

1. A filter name is not a file name, so it doesn't have to use any file naming conventions, such as NoSpaces, hyphens-instead-of-spaces, underscores_instead_of_spaces etc. It must be a normal, human-readable string.

2. It doesn't have to be unique. Our system is perfectly capable of handling identically-named filters -- we distinguish them by their author.

3. Don't include the author name in the filter name. It's already displayed near the filter name both on the website and within the program, so appending it to the filter name just adds unnecessary clutter. Some authors do it, but we don't think it's a good practice.

4. Title Case is a preferred way of capitalization (as opposed to ALL UPPERCASE and all lowercase). "My Cool Filter" is a good name, while "my cool filter" and "MY COOL FILTER" are not.

5. Tags are discouraged -- because most users won't know what they mean anyway.

6. Please, please, I beg of you, use spellcheckers before submitting! It just hurts my non-native-English-speaker eyes when I read some of the submitted names.
  Details E-Mail
Totte
Übernerd

Posts: 1460
Filters: 107
Quote
4. Title Case is a preferred way of capitalization (as opposed to ALL UPPERCASE and all lowercase). "My Cool Filter" is a good name, while "my cool filter" and "MY COOL FILTER" are not.

Opps - I think all my filters have lowercase only names, made that some kind of trademark for my filters.
- I never expected the Spanish inquisition
  Details E-Mail
Sjeiti
sock puppet

Posts: 722
Filters: 71
Nobody expects the Spanish inquisition!
  Details E-Mail
fisholith
Posts: 24
Filters: 2
Sounds good, thanks for the response.

Regarding item 1, I'm aware that the file names are different from the filter browser names, but it seems that there is no way to organize filters other than by amending prefixes to their browser names. That's okay though, as I suppose I can just temporarily remove the prefix before submitting the filter.

Regarding item 3, I'm fine with not using an author prefix, I was just curious what the norm was. As I said, it looked to me like it might just get in the way, and so I was leaning away from that.

Regarding item 5, if I understand correctly, you mean inclusion of tags in the title rather than in the filter details right?

That brings up a question about the "Median 3x3" filter. The "3x3" seems to me like an important element of the name (as opposed to a tag), because while the filter is a median, the fact that it always takes only 9 samples per out-pixel, means that it has some very specific behavioral differences from traditional medians with adaptive sample counts. Additionally, if I later build a 5x5 median, it seems best to simply call it that, rather than something more vague like "median plus". Granted some of that is just because I plan to submit it to the snippets section, which, being something of an algorithms repository, seems to merit a little more specificity.

Regarding item 6, I believe I spelled "median" correctly, unless you're referring to an error somewhere else, or just stating that as a general principal.

As it stands, I am planning to submit the filters with the following names.
"Median 3x3"
"Percentile 3x3"

Thanks again for the information. smile:)



Finally, with regard to inquisitions, and specifically those of Spanish provenance, would it not be simpler to simply ask, is it not true that it is that for which we all do not possess an expectation? I, for one, submit that that is that for which we do not. (I'm just saying...)
  Details E-Mail
Kraellin
Kraellin

Posts: 12749
Filters: 99
here's a couple other suggestions on title names:

1. put your 'rls' at the end, not the beginning. works better for searches.

2. put the main theme of the filter first. remember, version one doesnt have a search feature within the program.

3. a good convention is to think of how you would categorize the physical universe. by that, i mean something like 'rock(or stone)- granite - small v1'. 'rock' is more generic than 'granite', so it comes first. a person looking for rock filters is most likely going to look in the 'stone' category first. you want him/her to be able to find your filter easily. cutely named filters get lost in the massive library very easily, e.g. 'my cute pet rock' as opposed to 'rock - granite - small v1'. in other words, go from very broad and general down to more and more specific and that includes colors and other identifiers.

4. name the filter what the filter is about. that's really already covered above, but it bears repeating.

5. do not fall into the trap of putting non-alpha numeric characters at the beginning of the filter name to get it bumped up to the top of the category by ascii ordering. nobody searches for their filters by going to the top of the list (well, usually not, anyways). we tend to look for what the filter is about. "i want a filter about rocks. i'll look in the stone category under 'rock'".

6. this isnt actually about the filter name, but is close enough to be put here: use lots of keywords in your filter and keep them appropriate. FF1 doesnt have a search feature in the program, but you can search for filters in the library from the website and keywords put in by the author help greatly with finding a given filter. so, for our granite filter, keywords like granite, rock, stone, inorganic, solid, quarry, pebble, gravel, greystone, building, material, mountain, crag and so on would all pretty much be ok (in my book, anyways).

basically, you want your filter to be found, so think like a user. folks that use textures and effects like produced in FF can range from 3d artists, game makers, game map makers, photo artists, web page designers, scrapbookers, craftsfolk, artists of other types (like composite artists), and so on. so, ask yourself how they're going to come looking for a filter. what makes it easier for them to find your filter? and that's really the bottom line.
If wishes were horses... there'd be a whole lot of horse crap to clean up!

Craig
  Details E-Mail

Join Our Community!

Filter Forge has a thriving, vibrant, knowledgeable user community. Feel free to join us and have fun!

33,712 Registered Users
+19 new in 30 days!

153,533 Posts
+31 new in 30 days!

15,348 Topics
+73 new in year!

Create an Account

Online Users Last minute:

34 unregistered users.