Index: branches/tap_branches/magic/remove/Doxyfile.in =================================================================== --- branches/tap_branches/magic/remove/Doxyfile.in (revision 27838) +++ branches/tap_branches/magic/remove/Doxyfile.in (revision 27838) @@ -0,0 +1,1310 @@ +# Doxyfile 1.5.4 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file that +# follow. The default is UTF-8 which is also the encoding used for all text before +# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into +# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of +# possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = streaksremove + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = ipp-2.7.dev + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./docs + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, +# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, +# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, +# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes +# will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to +# include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is +# documented as struct with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code where the coding convention is that all structs are +# typedef'ed and only the typedef is referenced never the struct's name. + +TYPEDEF_HIDES_STRUCT = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be extracted +# and appear in the documentation as a namespace called 'anonymous_namespace{file}', +# where file will be replaced with the base name of the file that contains the anonymous +# namespace. By default anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from the +# version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text " + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = ./src + +# This tag can be used to specify the character encoding of the source files that +# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default +# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. +# See http://www.gnu.org/software/libiconv for the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.h + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the output. +# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, +# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH +# then you must also enable this option. If you don't then doxygen will produce +# a warning and turn it on anyway + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentstion. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = NO + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = YES + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to +# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to +# specify the directory where the mscgen tool resides. If left empty the tool is assumed to +# be found in the default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will +# generate a caller dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable caller graphs for selected +# functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the number +# of direct children of the root node in a graph is already larger than +# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, which results in a white background. +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO Index: branches/tap_branches/magic/remove/Makefile.am =================================================================== --- branches/tap_branches/magic/remove/Makefile.am (revision 27838) +++ branches/tap_branches/magic/remove/Makefile.am (revision 27838) @@ -0,0 +1,4 @@ +SUBDIRS = src + +CLEANFILES = *.pyc *~ core core.* + Index: branches/tap_branches/magic/remove/autogen.sh =================================================================== --- branches/tap_branches/magic/remove/autogen.sh (revision 27838) +++ branches/tap_branches/magic/remove/autogen.sh (revision 27838) @@ -0,0 +1,103 @@ +#!/bin/sh +# Run this to generate all the initial makefiles, etc. + +srcdir=`dirname $0` +test -z "$srcdir" && srcdir=. + +ORIGDIR=`pwd` +cd $srcdir + +PROJECT=streaks +TEST_TYPE=-f +# change this to be a unique filename in the top level dir +FILE=autogen.sh + +DIE=0 + +LIBTOOLIZE=libtoolize +ACLOCAL="aclocal $ACLOCAL_FLAGS" +AUTOHEADER=autoheader +AUTOMAKE=automake +AUTOCONF=autoconf + +($LIBTOOLIZE --version) < /dev/null > /dev/null 2>&1 || { + echo + echo "You must have $LIBTOOLIZE installed to compile $PROJECT." + echo "Download the appropriate package for your distribution," + echo "or get the source tarball at http://ftp.gnu.org/gnu/libtool/" + DIE=1 +} + +($ACLOCAL --version) < /dev/null > /dev/null 2>&1 || { + echo + echo "You must have $ACLOCAL installed to compile $PROJECT." + echo "Download the appropriate package for your distribution," + echo "or get the source tarball at http://ftp.gnu.org/gnu/automake/" + DIE=1 +} + +($AUTOHEADER --version) < /dev/null > /dev/null 2>&1 || { + echo + echo "You must have $AUTOHEADER installed to compile $PROJECT." + echo "Download the appropriate package for your distribution," + echo "or get the source tarball at http://ftp.gnu.org/gnu/autoconf/" + DIE=1 +} + +($AUTOMAKE --version) < /dev/null > /dev/null 2>&1 || { + echo + echo "You must have $AUTOMAKE installed to compile $PROJECT." + echo "Download the appropriate package for your distribution," + echo "or get the source tarball at http://ftp.gnu.org/gnu/automake/" + DIE=1 +} + +($AUTOCONF --version) < /dev/null > /dev/null 2>&1 || { + echo + echo "You must have $AUTOCONF installed to compile $PROJECT." + echo "Download the appropriate package for your distribution," + echo "or get the source tarball at http://ftp.gnu.org/gnu/autoconf/" + DIE=1 +} + +if test "$DIE" -eq 1; then + exit 1 +fi + +test $TEST_TYPE $FILE || { + echo "You must run this script in the top-level $PROJECT directory" + exit 1 +} + +if test -z "$*"; then + echo "I am going to run ./configure with no arguments - if you wish " + echo "to pass any to it, please specify them on the $0 command line." +fi + +$LIBTOOLIZE --copy --force || echo "$LIBTOOLIZE failed" +$ACLOCAL || echo "$ACLOCAL failed" +$AUTOHEADER || echo "$AUTOHEADER failed" +$AUTOMAKE --add-missing --force-missing --copy || echo "$AUTOMAKE failed" +$AUTOCONF || echo "$AUTOCONF failed" + +cd $ORIGDIR + +run_configure=true +for arg in $*; do + case $arg in + --no-configure) + run_configure=false + ;; + *) + ;; + esac +done + +if $run_configure; then + $srcdir/configure --enable-maintainer-mode "$@" + echo + echo "Now type 'make' to compile $PROJECT." +else + echo + echo "Now run 'configure' and 'make' to compile $PROJECT." +fi Index: branches/tap_branches/magic/remove/configure.ac =================================================================== --- branches/tap_branches/magic/remove/configure.ac (revision 27838) +++ branches/tap_branches/magic/remove/configure.ac (revision 27838) @@ -0,0 +1,43 @@ +dnl Process this file with autoconf to produce a configure script. +AC_PREREQ(2.61) + +AC_INIT([streaksremove], [0.9.0], [ipp-support@ifa.hawaii.edu]) +AC_CONFIG_SRCDIR([src]) + +AM_INIT_AUTOMAKE([1.6 foreign dist-bzip2]) +AM_CONFIG_HEADER([src/config.h]) +AM_MAINTAINER_MODE + +IPP_STDCFLAGS + +AC_LANG(C) +AC_GNU_SOURCE +AC_PROG_CC_C99 +AC_PROG_INSTALL +AC_PROG_LIBTOOL +AC_SYS_LARGEFILE + +dnl ------------------------------------------------------------ + +dnl ------------- psLib, psModules --------------- +PKG_CHECK_MODULES([PSLIB], [pslib >= 1.0.0]) +PKG_CHECK_MODULES([PSMODULE], [psmodules >= 1.0.0]) + +dnl Set CFLAGS for build +IPP_STDOPTS +CFLAGS="${CFLAGS=} -Wall -Werror" +echo "STREAKSREMOVE_CFLAGS: $STREAKSREMOVE_CFLAGS" +echo "STREAKSREMOVE_LIBS: $STREAKSREMOVE_LIBS" + +IPP_VERSION + +AC_SUBST([STREAKSREMOVE_CFLAGS]) +AC_SUBST([STREAKSREMOVE_LIBS]) + +AC_CONFIG_FILES([ + Makefile + src/Makefile + Doxyfile +]) + +AC_OUTPUT Index: branches/tap_branches/magic/remove/src/Makefile.am =================================================================== --- branches/tap_branches/magic/remove/src/Makefile.am (revision 27838) +++ branches/tap_branches/magic/remove/src/Makefile.am (revision 27838) @@ -0,0 +1,95 @@ +if HAVE_SVNVERSION +STREAKS_VERSION=`$(SVNVERSION) ..` +else +STREAKS_VERSION="UNKNOWN" +endif + +if HAVE_SVN +STREAKS_BRANCH=`$(SVN) info .. | $(SED) -n -e '/URL:/ h' -e '/Repository Root:/ { x; H; x; s|Repository Root: \(.*\)\nURL: \1\(.*\)|\2| ; s|^/|| ; s|/[a-zA-Z]*/src.*|| ; p }'` +STREAKS_SOURCE=`$(SVN) info | $(SED) -n -e 's/Repository UUID: // p'` +else +STREAKS_BRANCH="UNKNOWN" +STREAKS_SOURCE="UNKNOWN" +endif + +# Force recompilation of streaksVersion.c, since it gets the version information +streaksVersion.c: streaksVersionDefinitions.h +streaksVersionDefinitions.h: streaksVersionDefinitions.h.in FORCE + -$(RM) streaksVersionDefinitions.h + $(SED) -e "s|@STREAKS_VERSION@|\"$(STREAKS_VERSION)\"|" -e "s|@STREAKS_BRANCH@|\"$(STREAKS_BRANCH)\"|" -e "s|@STREAKS_SOURCE@|\"$(STREAKS_SOURCE)\"|" streaksVersionDefinitions.h.in > streaksVersionDefinitions.h +FORCE: ; + +bin_PROGRAMS = streaksremove streaksrelease streaksreplace streakscompare isdestreaked + +STREAKSREMOVE_CFLAGS=-DSTREAKS_COMPRESS_OUTPUT=1 + +STREAKSCFLAGS = $(STREAKSREMOVE_CFLAGS) $(PSMODULE_CFLAGS) $(PSLIB_CFLAGS) +STREAKSLDFLAGS = $(STREAKSREMOVE_LIBS) $(PSMODULE_LIBS) $(PSLIB_LIBS) + +streaksremove_CFLAGS = $(STREAKSCFLAGS) +streaksremove_LDFLAGS = $(STREAKSLDFLAGS) +streaksreplace_CFLAGS = $(STREAKSCFLAGS) +streaksreplace_LDFLAGS = $(STREAKSLDFLAGS) +streaksrelease_CFLAGS = $(STREAKSCFLAGS) +streaksrelease_LDFLAGS = $(STREAKSLDFLAGS) +streakscompare_CFLAGS = $(STREAKSCFLAGS) +streakscompare_LDFLAGS = $(STREAKSLDFLAGS) +isdestreaked_CFLAGS = $(STREAKSCFLAGS) +isdestreaked_LDFLAGS = $(STREAKSLDFLAGS) + +COMMON_SOURCES = \ + streaksio.c \ + streaksutil.c \ + streaksastrom.c \ + streaksVersion.c + +streaksremove_SOURCES = \ + streaksremove.c \ + streaksextern.c \ + diffedpixels.c \ + Line.c \ + $(COMMON_SOURCES) + +streaksrelease_SOURCES = \ + streaksrelease.c\ + streaksio.c \ + streaksutil.c \ + streaksastrom.c \ + streaksVersion.c + +streaksreplace_SOURCES = \ + streaksreplace.c\ + streaksio.c \ + streaksutil.c \ + streaksastrom.c \ + streaksVersion.c + +streakscompare_SOURCES = \ + streakscompare.c\ + streaksio.c \ + streaksutil.c \ + streaksastrom.c \ + streaksVersion.c + +isdestreaked_SOURCES = \ + isdestreaked.c\ + streaksio.c \ + streaksutil.c \ + streaksastrom.c \ + streaksVersion.c + +include_HEADERS = \ + streaksremove.h \ + streaksastrom.h \ + streaksextern.h \ + streaksio.h \ + streaksVersionDefinitions.h + +clean-local: + -rm -f TAGS + -rm -f tags + +# Tags for emacs and vi +tags: + etags `find . -name \*.[ch] -print` + ctags `find . -name \*.[ch] -print` Index: branches/tap_branches/magic/remove/src/Makefile.simple =================================================================== --- branches/tap_branches/magic/remove/src/Makefile.simple (revision 25900) +++ branches/tap_branches/magic/remove/src/Makefile.simple (revision 27838) @@ -10,24 +10,19 @@ REMOVE_OBJECTS= \ - ${COMMON_OBJECTS} \ streaksremove.o \ streaksextern.o \ - warpedpixels.o \ + diffedpixels.o \ Line.o REPLACE_OBJECTS= \ - ${COMMON_OBJECTS} \ streaksreplace.o COMPARE_OBJECTS= \ - ${COMMON_OBJECTS} \ streakscompare.o RELEASE_OBJECTS= \ - ${COMMON_OBJECTS} \ streaksrelease.o ISDESTREAKED_OBJECTS= \ - ${COMMON_OBJECTS} \ isdestreaked.o @@ -45,16 +40,27 @@ HEADERS=Line.h streaksastrom.h streaksextern.h streaksio.h streaksremove.h -all: ${PROGRAMS} +all: ${PROGRAMS} -${REMOVE_OBJECTS}: ${HEADERS} -streaksremove: ${REMOVE_OBJECTS} +# programs all depend on the common objects and the common headers +PROGRAM_OBJECTS = \ + ${REMOVE_OBJECTS} \ + ${REPLACE_OBJECTS} \ + ${COMPARE_OBJECTS} \ + ${RELEASE_OBJECTS} \ + ${ISDESTREAKED_OBJECTS} -streaksreplace: ${REPLACE_OBJECTS} +${COMMON_OBJECTS}: ${HEADERS} -streakscompare: ${COMPARE_OBJECTS} +${PROGRAM_OBJECTS}: ${HEADERS} ${COMMON_OBJECTS} -streaksrelease: ${RELEASE_OBJECTS} +streaksremove: ${REMOVE_OBJECTS} ${COMMON_OBJECTS} -isdestreaked: ${ISDESTREAKED_OBJECTS} +streaksreplace: ${REPLACE_OBJECTS} ${COMMON_OBJECTS} + +streakscompare: ${COMPARE_OBJECTS} ${COMMON_OBJECTS} + +streaksrelease: ${RELEASE_OBJECTS} ${COMMON_OBJECTS} + +isdestreaked: ${ISDESTREAKED_OBJECTS} ${COMMON_OBJECTS} Index: branches/tap_branches/magic/remove/src/diffedpixels.c =================================================================== --- branches/tap_branches/magic/remove/src/diffedpixels.c (revision 27838) +++ branches/tap_branches/magic/remove/src/diffedpixels.c (revision 27838) @@ -0,0 +1,277 @@ +#include "streaksremove.h" +#include "pmAstrometryWCS.h" + +#define DEBUG_PRINT 1 + +static void addTouchedPixels(streakFiles *sf, psString fileName); +static void nameCorners(psPlane pt[4]); +static int xLeft(psPlane *pt, int y); +static int xRight(psPlane *pt, int y); + +#define BL 0 +#define BR 1 +#define TL 2 +#define TR 3 + +// Examine the set of diff skycells and compute the pixels that were +// included in difference processing +bool +computeDiffedPixels(streakFiles *sf) +{ + bool status; + pmConfig *config = sf->config; + + psArray *skycells = psMetadataLookupPtr(&status, config->arguments, "SKYCELLS"); + if (skycells == NULL) { + return false; + } + + int n = psArrayLength(skycells); + + psRegion *bounds = pmChipPixels(sf->chip); + + int width = bounds->x1 - bounds->x0; + int height = bounds->y1 - bounds->y0; + + psFree(bounds); + + sf->diffedPixels = psImageAlloc(width, height, PS_TYPE_U8); + psImageInit(sf->diffedPixels, 0); + + for (int i=0; iinAstrom->fpa->toSky->type != PS_PROJ_DIS) { + pmAstromWriteWCS(header, sf->inAstrom->fpa, sf->chip, 0.001); + } + psFits *fits = psFitsOpen("diffedpixels.fits", "w"); + + psFitsWriteImage(fits, header, sf->diffedPixels, 0, NULL); + psFitsClose(fits); + psFree(header); + } + return true; +} + +static void +addTouchedPixels(streakFiles *sf, psString fileName) +{ + // read fits header + psFits *fits = psFitsOpen(fileName, "r"); + if (!fits) { + psError(PS_ERR_IO, false, "failed to open skycell file: %s", fileName); + streaksExit("", PS_EXIT_DATA_ERROR); + } + psMetadata *header = psFitsReadHeader(NULL, fits); + psFitsClose(fits); + if (!header) { + psError(PS_ERR_IO, false, "failed to read fixts header from skycell file: %s", fileName); + streaksExit("", PS_EXIT_DATA_ERROR); + } + // set up astrometry for conversion from skycell image to sky + pmAstromWCS *wcs = pmAstromWCSfromHeader(header); + if (!wcs) { + psError(PS_ERR_IO, false, "failed to read astrometry from skycell file: %s", fileName); + streaksExit("", PS_EXIT_DATA_ERROR); + } + int naxis1 = psMetadataLookupS32(NULL, header, "NAXIS1"); + int naxis2 = psMetadataLookupS32(NULL, header, "NAXIS2"); + + psFree(header); + + /* now set up our wrapper to the chip astrometry to apply to the whole chip */ + sf->astrom = streakSetAstrometry(sf->astrom, sf->stage, sf->inAstrom->fpa, sf->chip, false, NULL, + sf->diffedPixels->numCols, sf->diffedPixels->numRows); + + // convert corners of skycell to chip coordinates + // compute overlap with the chip using astrometry + psPlane pt[4]; + pt[0].x = 0; + pt[0].y = 0; + + pt[1].x = naxis1 - 1; + pt[1].y = 0; + + pt[2].x = naxis1 - 1; + pt[2].y = naxis2 - 1; + + pt[3].x = 0; + pt[3].y = naxis2 - 1; + + for (int i = 0; i < 4 ; i++ ) { + psSphere sky; + + // convert corner of skycell to sky coordinates + if (!pmAstromWCStoSky(&sky, wcs, &pt[i])) { + psErrorStackPrint(stderr, "failed to convert pt %d of %s to sky coords", i, fileName); + streaksExit("", PS_EXIT_DATA_ERROR); + } + strkPt p; + // convert to chip coordinates + if (!skyToCell(&p, sf->astrom, sky.r, sky.d)) { + psErrorStackPrint(stderr, "failed to convert pt %d of %s to sky coords", i, fileName); + streaksExit("", PS_EXIT_DATA_ERROR); + } + pt[i].x = round(p.x); + pt[i].y = round(p.y); + } + + psFree(wcs); + + // Identify the bottom left, bottom right, top left, and top right corners + nameCorners(pt); + +#ifdef DEBUG_PRINT + fprintf(stderr, "\nSKYCELL %s\n", fileName); + fprintf(stderr, "BL %f %f\n", pt[BL].x, pt[BL].y); + fprintf(stderr, "BR %f %f\n", pt[BR].x, pt[BR].y); + fprintf(stderr, "TL %f %f\n", pt[TL].x, pt[TL].y); + fprintf(stderr, "TR %f %f\n", pt[TR].x, pt[TR].y); +#endif + + int xmax = sf->diffedPixels->numCols - 1; + int ymin; + int ymax; + + if (pt[BL].y <= pt[BR].y) { + ymin = fmax(0, pt[BL].y); + } else { + ymin = fmax(0, pt[BR].y); + } + if (pt[TR].y >= pt[TL].y) { + ymax = fmin(pt[TR].y, sf->diffedPixels->numRows - 1); + } else { + ymax = fmin(pt[TL].y, sf->diffedPixels->numRows - 1); + } + +#if (DEBUG_PRINT > 1) + fprintf(stderr, "\nxmin: %d xmax: %d\n", 0, xmax); + fprintf(stderr, "\nymin: %d ymax: %d\n", ymin, ymax); +#endif + + // Now set the touched pixels + for (int y = ymin ; y <= ymax; y++) { + + int xleft = xLeft(pt, y) - 1; + int xright = xRight(pt, y) + 1; + + if (xright < 0) { + continue; + } + if (xleft > xmax) { + continue; + } + if (xleft < 0) { + xleft = 0; + } + if (xright > xmax) { + xright = xmax; + } +#if (DEBUG_PRINT > 1) + fprintf(stderr, " y: %d xleft: %d xright: %d\n", y, xleft, xright); +#endif + + psU8 *rowPixels = sf->diffedPixels->data.U8[y]; + + int n = xright - xleft + 1; + if (n > 0) { + memset(&rowPixels[xleft], 255, n); + } + } +} + +// x as a function of y for the line between two points +// Note: the caller guarentees that the y's of the two points are different +static double xOfY(psPlane *pI, psPlane *pJ, int y) +{ + double m_inv = (double) (pJ->x - pI->x) / (double) (pJ->y - pI->y); + + double x = ((double) y - pI->y) * m_inv + (double) pI->x; + + return x; +} + +static int xLeft(psPlane *pt, int y) +{ + double x_d; + + if ((y <= pt[BL].y ) && ((pt[BL].y >= pt[BR].y))) { + // left boundary is the line from bottom left to bottom right + x_d = xOfY(&pt[BL], &pt[BR], y); + } else if ( y <= pt[TL].y ) { + // left boundary is the line from Bottom left to top left + x_d = xOfY(&pt[BL], &pt[TL], y); + } else { + // left boundary is the line from top left to top right + x_d= xOfY(&pt[TL], &pt[TR], y); + } + + return (int) floor(x_d); +} + +static int xRight(psPlane *pt, int y) +{ + double x_d; + if ((y <= pt[BR].y) && (pt[BR].y > pt[BL].y)) { + // right boundary is the line from Bottom right to Top right + x_d = xOfY(&pt[BL], &pt[BR], y); + } else if ( y<= pt[TR].y) { + // right boundary is the line from Top left to top right + x_d = xOfY(&pt[BR], &pt[TR], y); + } else { + x_d = xOfY(&pt[TL], &pt[TR], y); + } + return (int) ceil(x_d); +} + +static void +nameCorners(psPlane pt[4]) +{ + // sort points top to bottom (in case of ties take favor rightmost) + int i; + int j; + for (i=0; i<4; i++) { + for (j = i + 1; j < 4; j++) { + if ((pt[j].y > pt[i].y) || + ((pt[j].y == pt[i].y) && (pt[j].x > pt[i].x))) { + psPlane tmpPt = pt[j]; + pt[j] = pt[i]; + pt[i] = tmpPt; + } + } + } + psPlane bl, br; + // sort bottom two points in x + if (pt[3].x < pt[2].x) { + bl = pt[3]; + br = pt[2]; + } else { + bl = pt[2]; + br = pt[3]; + } + // sort the top two points in x + psPlane tl, tr; + if (pt[0].x < pt[1].x) { + tl = pt[0]; + tr = pt[1]; + } else { + tl = pt[1]; + tr = pt[0]; + } + pt[BL] = bl; + pt[BR] = br; + pt[TL] = tl; + pt[TR] = tr; +} Index: branches/tap_branches/magic/remove/src/isdestreaked.c =================================================================== --- branches/tap_branches/magic/remove/src/isdestreaked.c (revision 25900) +++ branches/tap_branches/magic/remove/src/isdestreaked.c (revision 27838) @@ -1,3 +1,5 @@ #include "streaksremove.h" + +char *streaksProgram = "isdestreaked"; int Index: branches/tap_branches/magic/remove/src/streaksVersion.c =================================================================== --- branches/tap_branches/magic/remove/src/streaksVersion.c (revision 27838) +++ branches/tap_branches/magic/remove/src/streaksVersion.c (revision 27838) @@ -0,0 +1,113 @@ +/** @file streaksVersion.c + * + * @brief + * + * @ingroup streaks + * + * Copyright 2009 Institute for Astronomy, University of Hawaii + */ + +#include "streaksremove.h" +#include "streaksVersionDefinitions.h" + +#ifndef STREAKS_VERSION +#error "STREAKS_VERSION is not set" +#endif +#ifndef STREAKS_BRANCH +#error "STREAKS_BRANCH is not set" +#endif +#ifndef STREAKS_SOURCE +#error "STREAKS_SOURCE is not set" +#endif + +psString streaksVersion(void) +{ + char *value = NULL; + psStringAppend(&value, "%s@%s", STREAKS_BRANCH, STREAKS_VERSION); + return value; +} + +psString streaksSource(void) +{ + return psStringCopy(STREAKS_SOURCE); +} + +psString streaksVersionLong(void) +{ + psString version = streaksVersion(); // Version, to return + psString source = streaksSource(); // Source + + psStringPrepend(&version, "%s ", streaksProgram); + psStringAppend(&version, " from %s, built %s, %s", source, __DATE__, __TIME__); + psFree(source); + +#ifdef __OPTIMIZE__ + psStringAppend(&version, " optimised"); +#else + psStringAppend(&version, " unoptimised"); +#endif + + return version; +}; + +bool streaksVersionHeader(psMetadata *header) +{ + PS_ASSERT_METADATA_NON_NULL(header, false); + + psString version = streaksVersion(); // Software version + psString source = streaksSource(); // Software source + + psStringPrepend(&version, "%s version: ", streaksProgram); + psStringPrepend(&source, "%s source: ", streaksProgram); + + psMetadataAddStr(header, PS_LIST_TAIL, "HISTORY", PS_META_DUPLICATE_OK, NULL, version); + psMetadataAddStr(header, PS_LIST_TAIL, "HISTORY", PS_META_DUPLICATE_OK, NULL, source); + + psFree(version); + psFree(source); + + return true; +} + +bool streaksVersionHeaderFull(psMetadata *header) +{ + PS_ASSERT_METADATA_NON_NULL(header, false); + + psTime *time = psTimeGetNow(PS_TIME_TAI); // The time now + psString timeString = psTimeToISO(time); // The time in an ISO string + psFree(time); + psString history = NULL; // History string + psStringAppend(&history, "%s at %s", streaksProgram, timeString); + psFree(timeString); + psMetadataAddStr(header, PS_LIST_TAIL, "HISTORY", PS_META_DUPLICATE_OK, NULL, history); + psFree(history); + + psLibVersionHeader(header); + psModulesVersionHeader(header); + streaksVersionHeader(header); + + return true; +} + +void streaksVersionPrint(void) +{ + psTime *time = psTimeGetNow(PS_TIME_TAI); // The time now + psString timeString = psTimeToISO(time); // The time in an ISO string + psFree(time); + psLogMsg("streaks", PS_LOG_INFO, "%s at %s", streaksProgram, timeString); + psFree(timeString); + + psString pslib = psLibVersionLong();// psLib version + psString psmodules = psModulesVersionLong(); // psModules version + psString streaks = streaksVersionLong(); // streaks version + + psLogMsg("streaks", PS_LOG_INFO, "%s", pslib); + psLogMsg("streaks", PS_LOG_INFO, "%s", psmodules); + psLogMsg("streaks", PS_LOG_INFO, "%s", streaks); + + psFree(pslib); + psFree(psmodules); + psFree(streaks); + + return; +} Index: branches/tap_branches/magic/remove/src/streaksVersionDefinitions.h.in =================================================================== --- branches/tap_branches/magic/remove/src/streaksVersionDefinitions.h.in (revision 27838) +++ branches/tap_branches/magic/remove/src/streaksVersionDefinitions.h.in (revision 27838) @@ -0,0 +1,8 @@ +#ifndef STREAKS_VERSION_DEFINITIONS_H +#define STREAKS_VERSION_DEFINITIONS_H + +#define STREAKS_VERSION @STREAKS_VERSION@ // SVN version +#define STREAKS_BRANCH @STREAKS_BRANCH@ // SVN branch +#define STREAKS_SOURCE @STREAKS_SOURCE@ // SVN source + +#endif Index: branches/tap_branches/magic/remove/src/streaksastrom.c =================================================================== --- branches/tap_branches/magic/remove/src/streaksastrom.c (revision 25900) +++ branches/tap_branches/magic/remove/src/streaksastrom.c (revision 27838) @@ -378,7 +378,6 @@ linearizeTransforms(strkAstrom *astrom) { - if (!pmAstromLinearizeTransforms((pmFPA *) astrom->fpa, (pmChip *) astrom->chip)) { - // streaksExit("linear fit to astrometry failed\n", PS_EXIT_UNKNOWN_ERROR); - psError(PS_ERR_UNKNOWN, false, "linear fit to astrometry failed ignoring"); + if (!pmAstromLinearizeTransforms((pmFPA *) astrom->fpa, (pmChip *) astrom->chip, NULL, NULL, NULL, 0, 0)) { + psErrorStackPrint(stderr, "linear fit to astrometry failed. ignoring\n"); return false; } Index: branches/tap_branches/magic/remove/src/streakscompare.c =================================================================== --- branches/tap_branches/magic/remove/src/streakscompare.c (revision 25900) +++ branches/tap_branches/magic/remove/src/streakscompare.c (revision 27838) @@ -1,3 +1,5 @@ #include "streaksremove.h" + +char *streaksProgram = "streakscompare"; static pmConfig * parseArguments(int, char **); Index: branches/tap_branches/magic/remove/src/streaksextern.c =================================================================== --- branches/tap_branches/magic/remove/src/streaksextern.c (revision 25900) +++ branches/tap_branches/magic/remove/src/streaksextern.c (revision 27838) @@ -78,5 +78,5 @@ } } - printf("%d streaks on this component\n", streaksOnComponent); + fprintf(stderr, "%d streaks on this component\n", streaksOnComponent); return pixels; } Index: branches/tap_branches/magic/remove/src/streaksio.c =================================================================== --- branches/tap_branches/magic/remove/src/streaksio.c (revision 25900) +++ branches/tap_branches/magic/remove/src/streaksio.c (revision 27838) @@ -121,4 +121,14 @@ sf->transparentStreaks = psMetadataLookupF64(&status, config->arguments, "TRANSPARENT_STREAKS"); + sf->stats = psMetadataAlloc(); + psString statsFileName= psMetadataLookupStr(&status, config->arguments, "STATS"); + if (statsFileName) { + sf->statsFile = fopen(statsFileName, "w"); + if (!sf->statsFile) { + psError(PS_ERR_IO, true, "failed to open stats file %s", statsFileName); + streaksExit("", PS_EXIT_CONFIG_ERROR); + } + } + return sf; } @@ -128,5 +138,5 @@ { freeImages(sf); - psFree(sf->warpedPixels); + psFree(sf->diffedPixels); psFree(sf->tiles); psFree(sf->view); @@ -800,4 +810,6 @@ return; } + streaksVersionHeaderFull(sfile->header); + if (!psFitsWriteImage(sfile->fits, sfile->header, sfile->image, 0, extname)) { psError(PS_ERR_IO, false, "failed to write image to %s extnum: %d", @@ -817,4 +829,5 @@ return; } + streaksVersionHeaderFull(sfile->header); if (!psFitsWriteImageCube(sfile->fits, sfile->header, imagecube, extname)) { psError(PS_ERR_IO, false, "failed to write image to %s extnum: %d", @@ -851,7 +864,7 @@ sfile->header = NULL; psFree(sfile->image); - sfile->header = NULL; + sfile->image = NULL; psFree(sfile->imagecube); - sfile->header = NULL; + sfile->imagecube = NULL; } @@ -859,4 +872,14 @@ closeImages(streakFiles *sf) { + if (sf->stage == IPP_STAGE_RAW) { + if (sf->view) { + sf->view->readout = -1; + pmFPAfileIOChecks(sf->config, sf->view, PM_FPA_AFTER); + sf->view->cell = -1; + pmFPAfileIOChecks(sf->config, sf->view, PM_FPA_AFTER); + sf->view->chip = -1; + pmFPAfileIOChecks(sf->config, sf->view, PM_FPA_AFTER); + } + } closeImage(sf->inImage); closeImage(sf->outImage); @@ -913,6 +936,6 @@ bool free_user_copies = true; if (user_copies == NULL) { - user_copies = "2"; - free_user_copies = false; + // input does not have replication requested + return true; } if (!nebSetXattr(server, outFile->name, "user.copies", user_copies, NEB_REPLACE)) { @@ -920,5 +943,5 @@ return false; } - if (!nebReplicate(server, outFile->name, "any", NULL)) { + if (!nebReplicate(server, outFile->name, NULL, NULL)) { psError(PM_ERR_UNKNOWN, true, "nebReplicate failed for %s\n%s", outFile->name, nebErr(server)); return false; @@ -1111,10 +1134,16 @@ psImage *image = sfiles->outImage->image; + int imageType = image->type.type; + double exciseValue = sfiles->inImage->exciseValue; + psImage *mask = sfiles->inMask->image; psImage *weight = NULL; + int weightType = 0; + double weightExciseValue = NAN; if (sfiles->outWeight) { weight = sfiles->outWeight->image; - } - double exciseValue = sfiles->inImage->exciseValue; + weightType = weight->type.type; + weightExciseValue = sfiles->inWeight->exciseValue; + } if (printCounts) { @@ -1126,6 +1155,17 @@ // these gets are not necessary, we could just set the pixels to nan // but I want to get the counts - double imageVal = image->data.F32[y][x]; - psU32 maskVal; + double imageVal = 0; // avoid compiler warning + if (imageType == PS_TYPE_F32) { + imageVal = image->data.F32[y][x]; + } else if (imageType == PS_TYPE_S16) { + imageVal = image->data.S16[y][x]; + } else if (imageType == PS_TYPE_U16) { + imageVal = image->data.U16[y][x]; + } else { + psError(PS_ERR_PROGRAMMING, true, "unexpected image type found: %d\n", + imageType); + streaksExit("", PS_EXIT_PROG_ERROR); + } + psU32 maskVal = 0; if (sfiles->stage == IPP_STAGE_RAW) { unsigned int xChip, yChip; @@ -1137,13 +1177,41 @@ if (maskVal & maskMask) { ++maskedPixels; - if (!isExciseValue(imageVal, sfiles->inImage->exciseValue)) { + if (!isExciseValue(imageVal, exciseValue)) { ++nandPixels; - image->data.F32[y][x] = exciseValue; + if (imageType == PS_TYPE_F32) { + image->data.F32[y][x] = exciseValue; + } else if (imageType == PS_TYPE_S16) { + image->data.S16[y][x] = exciseValue; + } else if (imageType == PS_TYPE_U16) { + image->data.U16[y][x] = exciseValue; + } else { + psError(PS_ERR_PROGRAMMING, true, "unexpected image type found: %d\n", + imageType); + streaksExit("", PS_EXIT_PROG_ERROR); + } } if (weight) { - double weightVal = weight ? weight->data.F32[y][x] : 0; - if (!isnan(weightVal)) { - ++nandWeights; - weight->data.F32[y][x] = NAN; + if (weightType == PS_TYPE_F32) { + double weightVal = weight->data.F32[y][x]; + if (!isnan(weightVal)) { + ++nandWeights; + weight->data.F32[y][x] = NAN; + } + } else if(weightType == PS_TYPE_S16) { + double weightVal = weight->data.S16[y][x]; + if (!isExciseValue(weightVal, weightExciseValue)) { + ++nandWeights; + image->data.S16[y][x] = weightExciseValue; + } + } else if (weightType == PS_TYPE_U16) { + double weightVal = weight->data.U16[y][x]; + if (!isExciseValue(weightVal, weightExciseValue)) { + ++nandWeights; + image->data.U16[y][x] = weightExciseValue; + } + } else { + psError(PS_ERR_PROGRAMMING, true, "unexpected image type found: %d\n", + weightType); + streaksExit("", PS_EXIT_PROG_ERROR); } } @@ -1176,12 +1244,26 @@ psMetadataAddU16(in->header, PS_LIST_TAIL, "BLANK", 0, "", 65535); psMetadataAddU16(in->header, PS_LIST_TAIL, "ZBLANK", 0, "", 65535); - } else { + } else if (in->image->type.type == PS_TYPE_S16) { + in->exciseValue = 32767; + psMetadataAddU16(in->header, PS_LIST_TAIL, "BLANK", 0, "", 32767); + psMetadataAddU16(in->header, PS_LIST_TAIL, "ZBLANK", 0, "", 32767); + } else if (in->image->type.type == PS_TYPE_F32) { in->exciseValue = NAN; - } -} - -void -strkGetMaskValues(streakFiles *sfiles, psU32 *maskStreak, psU32 *maskMask) -{ + } else { + psError(PS_ERR_PROGRAMMING, true, "unexpected image type found: %d\n", in->image->type.type); + streaksExit("", PS_EXIT_PROG_ERROR); + } +} + +// Get the mask values that we need. +// If an input mask file is provided get them from there. +// Otherwise get them from the recipe MASKS +void +strkGetMaskValues(streakFiles *sfiles) +{ + if (sfiles->maskStreak) { + // already done + return; + } if (sfiles->inMask && sfiles->inMask->header) { if (!pmConfigMaskReadHeader(sfiles->config, sfiles->inMask->header)) { @@ -1196,5 +1278,5 @@ streaksExit("", PS_EXIT_CONFIG_ERROR); } - *maskStreak = psMetadataLookupU32(&status, masks, "STREAK"); + sfiles->maskStreak = psMetadataLookupU32(&status, masks, "STREAK"); if (!status) { psError(PM_ERR_CONFIG, false, "failed to lookup mask value for STREAK in recipes\n"); @@ -1212,5 +1294,5 @@ } } - *maskMask = ~convPoor; + sfiles->maskMask = ~convPoor; } Index: branches/tap_branches/magic/remove/src/streaksio.h =================================================================== --- branches/tap_branches/magic/remove/src/streaksio.h (revision 25900) +++ branches/tap_branches/magic/remove/src/streaksio.h (revision 27838) @@ -16,5 +16,5 @@ void copyFitsOptions(sFile *out, sFile *rec, sFile *in, psVector *tiles); void setupImageRefs(sFile *out, sFile *recoveryOut, sFile *in, int extnum, bool exciseAll); -void strkGetMaskValues(streakFiles *sfiles, psU32 *maskStreak, psU32 *maskMask); +void strkGetMaskValues(streakFiles *sfiles); void copyExtraExtensions(streakFiles *sfiles); Index: branches/tap_branches/magic/remove/src/streaksrelease.c =================================================================== --- branches/tap_branches/magic/remove/src/streaksrelease.c (revision 25900) +++ branches/tap_branches/magic/remove/src/streaksrelease.c (revision 27838) @@ -4,4 +4,6 @@ static bool readAndCopyToOutput(streakFiles *sf, bool exciseAll); static void writeImages(streakFiles *sf, bool exciseImageCube); + +char *streaksProgram = "streaksrelease"; int @@ -16,8 +18,4 @@ return PS_EXIT_CONFIG_ERROR; } - - // Values to set for masked pixels - psU32 maskStreak = 0; // for the image and weight (usually NAN, MAXINT for integer images) - psU32 maskMask = 0; // value looked up for MASK.STREAK // Does true work here? @@ -50,9 +48,9 @@ // now that we've read the input files, lookup the mask values that we read - if (maskStreak == 0) { - strkGetMaskValues(sfiles, &maskStreak, &maskMask); - } - - setMaskedToNAN(sfiles, maskMask, true); + strkGetMaskValues(sfiles); + + if (!sfiles->inImage->imagecube) { + setMaskedToNAN(sfiles, sfiles->maskMask, true); + } // write out the destreaked temporary images and the recovery images @@ -226,9 +224,6 @@ if (sf->inImage->image) { setupImageRefs(sf->outImage, sf->recImage, sf->inImage, sf->extnum, exciseAll); - } else if (sf->inImage->imagecube) { - // Image cubes should have been excised in the destreaking process - streaksExit("unexpected imagecube found", PS_EXIT_CONFIG_ERROR); } else { - return false; + // image cubes are handled specially } @@ -278,4 +273,5 @@ +// XXXX: why isn't this in streaksio.c ?? See also streakremove.c static void writeImages(streakFiles *sf, bool exciseImageCube) @@ -303,18 +299,4 @@ } - // borrow one of the images from the imagecube and set it to init value - psImage *image = psArrayGet (sf->inImage->imagecube, 0); - psMemIncrRefCounter(image); - psImageInit(image, initValue); - if (exciseImageCube) { - sf->outImage->image = image; - writeImage(sf->outImage, extname, sf->extnum); - } else { - // write zero valued image to reccovery - if (sf->recImage) { - sf->recImage->image = image; - writeImage(sf->recImage, extname, sf->extnum); - } - } // Assumption: there are no mask and weight images for video cells return; Index: branches/tap_branches/magic/remove/src/streaksremove.c =================================================================== --- branches/tap_branches/magic/remove/src/streaksremove.c (revision 25900) +++ branches/tap_branches/magic/remove/src/streaksremove.c (revision 27838) @@ -12,12 +12,18 @@ static pmConfig *parseArguments(int argc, char **argv); static bool readAndCopyToOutput(streakFiles *sf, bool exciseAll); -static void exciseNonWarpedPixels(streakFiles *sfiles, psImageMaskType newMaskValue); -static bool warpedPixel(streakFiles *sfiles, int x, int y); +static long exciseNonDiffedPixels(streakFiles *sfiles, psImageMaskType newMaskValue); +static bool diffedPixel(streakFiles *sfiles, int x, int y); static void excisePixel(streakFiles *sfiles, unsigned int x, unsigned int y, bool streak, psImageMaskType newMaskValue); static void writeImages(streakFiles *sf, bool exciseImageCube); static void updateAstrometry(streakFiles *sfiles); static void censorSources(streakFiles *sfiles, psImageMaskType maskStreak); -static long censorPixels(streakFiles *sfiles, psImage * pixels, bool checkNonWarpedPixels, psU16 maskStreak); - +static long censorPixels(streakFiles *sfiles, psImage * pixels, bool checkNonDiffedPixels, psU16 maskStreak); + +char *streaksProgram = "streaksremove"; + +// Note: For clarity the flow of this program is in main(). +// There is not a lot of error checking is done in main. +// Until the end, where we might be doing Nebulous operations, called functions exit when an error +// is encountered. int main(int argc, char *argv[]) @@ -26,5 +32,5 @@ psLibInit(NULL); - psTimerStart("STREAKSREMOVE"); + psTimerStart("TOTAL_TIME"); pmConfig *config = parseArguments(argc, argv); @@ -33,8 +39,4 @@ streaksExit("", PS_EXIT_CONFIG_ERROR); } - - // Values to set for masked pixels - psU32 maskStreak = 0; // for the image and weight (usually NAN, MAXINT for integer images) - psU32 maskMask = 0; // value looked up for MASK.STREAK psString streaksFileName = psMetadataLookupStr(NULL, config->arguments, "STREAKS"); @@ -50,4 +52,5 @@ streakFiles *sfiles = openFiles(config, true, argv[0]); setupAstrometry(sfiles); + sfiles->stats = psMetadataAlloc(); // Optionally we can set pixels that are masked to NAN since they couldn't have been @@ -61,12 +64,12 @@ bool exciseAll = false; - // --keepnonwarped is a test and debug mode - bool keepNonWarpedPixels = psMetadataLookupBool(&status, config->arguments, "KEEP_NON_WARPED"); - - // we need to check for non warped pixels unless we've been asked not to or the stage is diff - // (By definition pixels in diff images were included in a diff) - bool checkNonWarpedPixels = ! (keepNonWarpedPixels || (sfiles->stage == IPP_STAGE_DIFF) ); - - if (checkNonWarpedPixels ) { + // --keepnondiffed is a test and debug mode + bool keepNonDiffedPixels = psMetadataLookupBool(&status, config->arguments, "KEEP_NON_DIFFED"); + + // we need to check for non diffed pixels unless we've been asked not to or the stage is diff + // (By definition pixels in diff images were included in the difference images) + bool checkNonDiffedPixels = ! (keepNonDiffedPixels || (sfiles->stage == IPP_STAGE_DIFF) ); + + if (checkNonDiffedPixels ) { // From magic ICD: // In the raw and detrended images, the pixels which were not @@ -76,11 +79,12 @@ // if no skycells are provided sfiles->exciseAll is set to true - psTimerStart("COMPUTE_WARPED_PIXELS"); - if (! computeWarpedPixels(sfiles) ) { + psTimerStart("COMPUTE_DIFFED_PIXELS"); + if (! computeDiffedPixels(sfiles) ) { // we have no choice to excise all pixels exciseAll = true; } - psF64 cwp_t = psTimerClear("COMPUTE_WARPED_PIXELS"); - psLogMsg("streaksremove", PS_LOG_INFO, "time to compute warped pixels: %f\n", cwp_t); + psF64 cdp_t = psTimerClear("COMPUTE_DIFFED_PIXELS"); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "COMPUTE_UNDIFFED_PIXELS", PS_META_REPLACE, "time to compute non-diffedpixels", cdp_t); + psLogMsg("streaksremove", PS_LOG_INFO, "time to compute diffed pixels: %f\n", cdp_t); } @@ -100,5 +104,13 @@ long totalPixels = 0; long totalStreakPixels = 0; - + long nonDiffedPixels = 0; + + // accumulators for the various timers + psF64 gsp_t = 0; + psF64 enw_t = 0; + psF64 rms_t = 0; + psF64 cs_t = 0; + psF64 wi_t = 0; + psF64 ua_t = 0; // Iterate through each component of the input (except for raw images there is only one) do { @@ -118,7 +130,5 @@ // now that we've read the input files, lookup the mask values - if (maskStreak == 0) { - strkGetMaskValues(sfiles, &maskStreak, &maskMask); - } + strkGetMaskValues(sfiles); totalPixels += sfiles->inImage->numRows * sfiles->inImage->numCols; @@ -132,4 +142,6 @@ StreakPixels *pixels = streak_on_component(streaks, sfiles->astrom, sfiles->inImage->numCols, sfiles->inImage->numRows); + gsp_t += psTimerClear("GET_STREAK_PIXELS"); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "GET_STREAK_PIXELS", PS_META_REPLACE, "", gsp_t); psLogMsg("streaksremove", PS_LOG_INFO, "time to get streak pixels: %f\n", psTimerClear("GET_STREAK_PIXELS")); @@ -137,23 +149,27 @@ // otherwise it contained an image cube (video cell) which is handled in the if block if (sfiles->inImage->image) { - if (checkNonWarpedPixels) { - psTimerStart("EXCISE_NON_WARPED"); - - // set non-warped pixels and variance to NAN, mask to maskStreak (since the pixel + if (checkNonDiffedPixels) { + psTimerStart("EXCISE_NON_DIFFED"); + + // set non-diffed pixels and variance to NAN, mask to maskStreak (since the pixel // is excised as part of the destreaking process) - exciseNonWarpedPixels(sfiles, maskStreak); - - psLogMsg("streaksremove", PS_LOG_INFO, "time to excise non warped pixels: %f\n", psTimerClear("EXCISE_NON_WARPED")); + nonDiffedPixels += exciseNonDiffedPixels(sfiles, sfiles->maskStreak); + + enw_t += psTimerClear("EXCISE_NON_DIFFED"); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "EXCISE_NON_DIFFED", PS_META_REPLACE, "", enw_t); + psLogMsg("streaksremove", PS_LOG_INFO, "time to excise non diffed pixels: %f\n", enw_t); } psTimerStart("REMOVE_STREAKS"); - totalStreakPixels += censorPixels(sfiles, pixels, checkNonWarpedPixels, maskStreak); - - psLogMsg("streaksremove", PS_LOG_INFO, "time to remove streak pixels: %f\n", psTimerClear("REMOVE_STREAKS")); + totalStreakPixels += censorPixels(sfiles, pixels, checkNonDiffedPixels, sfiles->maskStreak); + + rms_t += psTimerClear("REMOVE_STREAKS"); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "REMOVE_STREAKS", PS_META_REPLACE, "", enw_t); + psLogMsg("streaksremove", PS_LOG_INFO, "time to remove streak pixels: %f\n", rms_t); if (nanForRelease) { // set any pixels that were masked, to NAN (unless they are already NAN) - setMaskedToNAN(sfiles, maskMask, true); + setMaskedToNAN(sfiles, sfiles->maskMask, true); } @@ -170,14 +186,24 @@ // chip processed files with the data calcuated by psastro at the camera stage // (actually we use a linear approximation) + psTimerStart("UPDATE_ASTROMETRY"); updateAstrometry(sfiles); - } - - censorSources(sfiles, maskStreak); + ua_t += psTimerClear("UPDATE_ASTROMETRY"); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "UPDATE_ASTROMETRY", PS_META_REPLACE, "", ua_t); + psLogMsg("streaksremove", PS_LOG_INFO, "time to update astrometry: %f\n", ua_t); + } + + psTimerStart("CENSOR_SOURCES"); + censorSources(sfiles, sfiles->maskStreak); + cs_t += psTimerClear("CENSOR_SOURCES"); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "CENSOR_SOURCES", PS_META_REPLACE, "", cs_t); // write the destreaked "temporary" images and the recovery images + psTimerStart("WRITE_IMAGES"); writeImages(sfiles, exciseImageCube); - + wi_t += psTimerClear("WRITE_IMAGES"); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "WRITE_IMAGES", PS_META_REPLACE, "", wi_t); psLogMsg("streaksremove", PS_LOG_INFO, "time to process component %d: %f\n", sfiles->extnum, psTimerClear("PROCESS_COMPONENT")); + } while (streakFilesNextExtension(sfiles)); @@ -185,5 +211,16 @@ psFree(streaks); - psLogMsg("streaksremove", PS_LOG_INFO, "pixels: %ld streak pixels: %ld %4.2f%%\n", totalPixels, totalStreakPixels, 100. * totalStreakPixels / totalPixels); + if (exciseAll) { + totalStreakPixels = totalPixels; + } + + psF64 streakFraction = (double) totalStreakPixels / totalPixels; + psLogMsg("streaksremove", PS_LOG_INFO, " total pixels: %8ld\n", totalPixels); + psLogMsg("streaksremove", PS_LOG_INFO, " streak pixels: %8ld %4.2f%%\n", totalStreakPixels, streakFraction * 100); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "STREAK_FRACTION", PS_META_REPLACE, "", streakFraction); + + psF64 nonDiffedFraction = (double) nonDiffedPixels / totalPixels; + psLogMsg("streaksremove", PS_LOG_INFO, "nondiffed pixels: %8ld %4.2f%%\n", nonDiffedPixels, nonDiffedFraction * 100); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "NONDIFFED_FRACTION", PS_META_REPLACE, "", nonDiffedFraction); // check the weight and mask files for extra extensions that might be in files @@ -194,10 +231,12 @@ psTimerStart("CLOSE_IMAGES"); - closeImages(sfiles); - - psLogMsg("streaksremove", PS_LOG_INFO, "time to close images: %f\n", psTimerClear("CLOSE_IMAGES")); - - + psF64 ci_t = psTimerClear("CLOSE_IMAGES"); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "CLOSE_IMAGES", PS_META_REPLACE, "", ci_t); + + psLogMsg("streaksremove", PS_LOG_INFO, "time to close images: %f\n", ci_t); + +#ifdef DO_REPLICATE + psTimerStart("REPLICATE_OUTPUTS"); if (!replicateOutputs(sfiles)) { psErrorStackPrint(stderr, "failed to replicate output files"); @@ -205,4 +244,7 @@ exit(PS_EXIT_UNKNOWN_ERROR); } + psF64 ro_t = psTimerClear("REPLICATE_OUTPUTS"); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "REPLICATE_OUTPUTS", PS_META_REPLACE, "", ro_t); +#endif // NOTE: from here on we can't just quit if something goes wrong. @@ -214,9 +256,9 @@ // swap the instances for the input and output // Note this is a nebulous database operation. No file I/O is performed + psTimerStart("SWAP_INSTANCES"); if (!swapOutputsToInputs(sfiles)) { - // XXX: Now what? // It is up to the program that reverts failed destreak runs to insure that - // any input files that have been swapped are restored and that the de-streaked - // versions are deleted + // any original non-destreaked input files that have been swapped are restored and that the de-streaked + // versions are deleted. psErrorStackPrint(stderr, "failed to swap files"); @@ -224,4 +266,24 @@ // XXX: pick a specific error code for this failure exit(PS_EXIT_UNKNOWN_ERROR); + } + psF64 si_t = psTimerClear("SWAP_INSTANCES"); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "SWAP_INSTANCES", PS_META_REPLACE, "", si_t); + } + + psF64 total_time = psTimerClear("TOTAL_TIME"); + psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "TOTAL_TIME", PS_META_REPLACE, "", total_time); + psLogMsg("streaksremove", PS_LOG_INFO, "time to run streaksremove: %f\n", total_time); + + if (sfiles->statsFile) { + const char *statsMDC = psMetadataConfigFormat(sfiles->stats); + if (!statsMDC || strlen(statsMDC) == 0) { + psError(PS_ERR_IO, false, "Unable to get statistics MDC file.\n"); + } else { + fprintf(sfiles->statsFile, "%s", statsMDC); + psFree(statsMDC); + fclose(sfiles->statsFile); + sfiles->statsFile = NULL; + psFree(sfiles->stats); + sfiles->stats = NULL; } } @@ -234,5 +296,4 @@ streaksNebulousCleanup(); pmConfigDone(); - psLogMsg("streaksremove", PS_LOG_INFO, "time to run streaksremove: %f\n", psTimerClear("STREAKSREMOVE")); psLibFinalize(); @@ -243,5 +304,5 @@ static long -censorPixels(streakFiles *sfiles, psImage *pixels, bool checkNonWarpedPixels, psU16 maskStreak) +censorPixels(streakFiles *sfiles, psImage *pixels, bool checkNonDiffedPixels, psU16 maskStreak) { long streakPixels = 0; @@ -250,6 +311,6 @@ for (int x = 0; x < sfiles->inImage->numCols; x++) { if (psImageGet(pixels, x, y)) { - ++streakPixels; - if (!checkNonWarpedPixels || warpedPixel(sfiles, x, y)) { + if (!checkNonDiffedPixels || diffedPixel(sfiles, x, y)) { + ++streakPixels; excisePixel(sfiles, x, y, true, maskStreak); @@ -257,5 +318,5 @@ } else { // This pixel was not included in any warp and has thus already excised - // by exciseNonWarpedPixels + // by exciseNonDiffedPixels } } @@ -274,5 +335,5 @@ fprintf(stderr, "\t-weight WEIGHT.fits: weight file to de-streak\n"); fprintf(stderr, "\t-replace: replace the input images with the output\n"); - fprintf(stderr, "\t-keepnonwarped: do not exise pixels that were not part of difference processing\n"); + fprintf(stderr, "\t-keepnondiffed: do not exise pixels that were not part of difference processing\n"); fprintf(stderr, "\t-transparent val: instead of setting excicsed pixel to NAN add val\n"); fprintf(stderr, "\t-chip_mask MASK.fits: name of mask for chip stage (camera stage mask is passed tih -mask)\n"); @@ -365,8 +426,8 @@ } - if ((argnum = psArgumentGet(argc, argv, "-keepnonwarped"))) { - psArgumentRemove(argnum, &argc, argv); - psMetadataAddBool(config->arguments, PS_LIST_TAIL, "KEEP_NON_WARPED", 0, - "skip excising of non warped pixels", true); + if ((argnum = psArgumentGet(argc, argv, "-keepnondiffed"))) { + psArgumentRemove(argnum, &argc, argv); + psMetadataAddBool(config->arguments, PS_LIST_TAIL, "KEEP_NON_DIFFED", 0, + "skip excising of non diffed pixels", true); } @@ -378,10 +439,10 @@ psArgumentRemove(argnum, &argc, argv); double transparentStreaks = atof(argv[argnum]); - psMetadataAddF64(config->arguments, PS_LIST_TAIL, "TRANSPARENT_STREAKS", 0, + psMetadataAddF32(config->arguments, PS_LIST_TAIL, "TRANSPARENT_STREAKS", 0, "value to adjust excised pixels", transparentStreaks); psArgumentRemove(argnum, &argc, argv); } - // if skycells are not provided then we have to execise all pixels unless -keepnonwarped + // if skycells are not provided then we have to execise all pixels unless -keepnondiffed pmConfigFileSetsMD(config->arguments, &argc, argv, "SKYCELLS", "-skycell", "-skycelllist"); @@ -449,4 +510,11 @@ } + if ((argnum = psArgumentGet(argc, argv, "-stats"))) { + psArgumentRemove(argnum, &argc, argv); + psMetadataAddStr(config->arguments, PS_LIST_TAIL, "STATS", 0, + "name of input stats file", argv[argnum]); + psArgumentRemove(argnum, &argc, argv); + } + if ((argnum = psArgumentGet(argc, argv, "-tmproot"))) { psArgumentRemove(argnum, &argc, argv); @@ -491,21 +559,28 @@ updateAstrometry(streakFiles *sf) { - // XXX: why do I check this here? Shouldn't it be just around the call to linearizeTransforms? if (sf->bilevelAstrometry) { - if (!linearizeTransforms(sf->astrom)) { - // fit failed, leave the astrometry unchanged + // fit failed, leave the transform in the file unchanged return; } - - if (!pmAstromWriteWCS(sf->outImage->header, sf->inAstrom->fpa, sf->chip, 0.001)) { - psError(PS_ERR_UNKNOWN, false, "failed to update astrometry for extension %d", sf->extnum); - streaksExit("", PS_EXIT_UNKNOWN_ERROR); - } - if (sf->outMask) { - pmAstromWriteWCS(sf->outMask->header, sf->inAstrom->fpa, sf->chip, 0.001); - } - if (sf->outWeight) { - pmAstromWriteWCS(sf->outWeight->header, sf->inAstrom->fpa, sf->chip, 0.001); + } + if (!pmAstromWriteWCS(sf->outImage->header, sf->inAstrom->fpa, sf->chip, 0.001)) { + psError(PS_ERR_UNKNOWN, false, "failed to update astrometry for extension %d", sf->extnum); + streaksExit("", PS_EXIT_UNKNOWN_ERROR); + } + if (sf->outMask) { + pmAstromWriteWCS(sf->outMask->header, sf->inAstrom->fpa, sf->chip, 0.001); + } + if (sf->outWeight) { + pmAstromWriteWCS(sf->outWeight->header, sf->inAstrom->fpa, sf->chip, 0.001); + } +} + +static void +setStreakBits(psImage *maskImage, psU32 maskStreak) +{ + for (int y=0 ; y < maskImage->numRows; y++) { + for (int x=0 ; x < maskImage->numCols; x++) { + maskImage->data.PS_TYPE_IMAGE_MASK_DATA[y][x] |= maskStreak; } } @@ -516,5 +591,4 @@ readAndCopyToOutput(streakFiles *sf, bool exciseAll) { - bool updateAstrometry = false; if (sf->inImage->pmfile) { // image data from pmFPAfile (diff or warp file) @@ -534,15 +608,4 @@ streaksExit("", PS_EXIT_UNKNOWN_ERROR); } - // For the chip level files, copy the WCS from the astrometry file to the header - // XXX: do we want to do this for raw images as well? - if (sf->stage == IPP_STAGE_CHIP) { - if (!sf->bilevelAstrometry) { - updateAstrometry = true; - if (!pmAstromWriteWCS(sf->inImage->header, sf->inAstrom->fpa, sf->chip, 0.001)) { - psError(PS_ERR_UNKNOWN, false, "failed to update astrometry for extension %d", sf->extnum); - streaksExit("", PS_EXIT_UNKNOWN_ERROR); - } - } - } sf->outImage->header = psMemIncrRefCounter(sf->inImage->header); if (sf->recImage) { @@ -577,8 +640,12 @@ } addDestreakKeyword(sf->outMask->header); - if (updateAstrometry) { - pmAstromWriteWCS(sf->outMask->header, sf->inAstrom->fpa, sf->chip, 0.001); - } - setupImageRefs(sf->outMask, sf->recMask, sf->inMask, sf->extnum, exciseAll); + // Note: we don't excise the mask pixels even if exciseAll is true. + setupImageRefs(sf->outMask, sf->recMask, sf->inMask, sf->extnum, false); + if (exciseAll) { + strkGetMaskValues(sf); + + // add the STREAK bit to the mask image pixels + setStreakBits(sf->inMask->image, sf->maskStreak); + } if (sf->outChMask) { sf->outChMask->header = (psMetadata *) psMemIncrRefCounter(sf->outMask->header); @@ -605,7 +672,4 @@ } addDestreakKeyword(sf->outWeight->header); - if (updateAstrometry) { - pmAstromWriteWCS(sf->inWeight->header, sf->inAstrom->fpa, sf->chip, 0.001); - } setupImageRefs(sf->outWeight, sf->recWeight, sf->inWeight, sf->extnum, exciseAll); @@ -630,27 +694,31 @@ } else { // we have an image cube - double initValue; if (exciseImageCube) { // copy the entire input image to the recovery image writeImageCube(sf->recImage, sf->inImage->imagecube, extname, sf->extnum); - initValue = NAN; } else { // otherwise write it to the output writeImageCube(sf->outImage, sf->inImage->imagecube, extname, sf->extnum); - initValue = 0; - } - - // borrow one of the images from the imagecube and set it to init value - psImage *image = psArrayGet (sf->inImage->imagecube, 0); - psMemIncrRefCounter(image); - psImageInit(image, initValue); + } + + // Now deal with the other output image if (exciseImageCube) { - sf->outImage->image = image; - writeImage(sf->outImage, extname, sf->extnum); + // Set the values in the imagecube images to NAN and write them to the output image + for (int i = 0; i < psArrayLength(sf->inImage->imagecube); i++) { + psImage *image = psArrayGet (sf->inImage->imagecube, i); + // XXX: NAN isn't right. It should be the integer equivalent. Should use exciseValue + // but it isn't set with this code path. Fix that. + psImageInit(image, 65535); + } + writeImageCube(sf->outImage, sf->inImage->imagecube, extname, sf->extnum); } else { - // write zero valued image to reccovery if (sf->recImage) { - sf->recImage->image = image; - writeImage(sf->recImage, extname, sf->extnum); + // Set the values in the imagecube images to zero + for (int i = 0; i < psArrayLength(sf->inImage->imagecube); i++) { + psImage *image = psArrayGet (sf->inImage->imagecube, i); + psImageInit(image, 0); + } + // copy the entire zeroed image to the recovery image + writeImageCube(sf->recImage, sf->inImage->imagecube, extname, sf->extnum); } } @@ -683,17 +751,35 @@ } - float imageValue = sfiles->inImage->image->data.F32[y][x]; - if (sfiles->recImage && !isExciseValue(imageValue, sfiles->inImage->exciseValue) ) { - sfiles->recImage->image->data.F32[y][x] = imageValue; - } - - if (sfiles->transparentStreaks == 0) { - sfiles->outImage->image->data.F32[y][x] = exciseValue; + if (sfiles->inImage->image->type.type == PS_TYPE_U16) { + psU16 imageValue = sfiles->inImage->image->data.U16[y][x]; + if (sfiles->recImage && !isExciseValue(imageValue, sfiles->inImage->exciseValue) ) { + sfiles->recImage->image->data.U16[y][x] = imageValue; + } + + if (sfiles->transparentStreaks == 0) { + sfiles->outImage->image->data.U16[y][x] = exciseValue; + } else { + if (streak) { + // as a visualization aid don't mask the pixel, just change the intensity + sfiles->outImage->image->data.U16[y][x] = imageValue + sfiles->transparentStreaks; + } else { + sfiles->outImage->image->data.U16[y][x] = exciseValue; + } + } } else { - if (streak) { - // as a visualization aid don't mask the pixel, just change the intensity - sfiles->outImage->image->data.F32[y][x] = imageValue + sfiles->transparentStreaks; + float imageValue = sfiles->inImage->image->data.F32[y][x]; + if (sfiles->recImage && !isExciseValue(imageValue, sfiles->inImage->exciseValue) ) { + sfiles->recImage->image->data.F32[y][x] = imageValue; + } + + if (sfiles->transparentStreaks == 0) { + sfiles->outImage->image->data.F32[y][x] = exciseValue; } else { - sfiles->outImage->image->data.F32[y][x] = exciseValue; + if (streak) { + // as a visualization aid don't mask the pixel, just change the intensity + sfiles->outImage->image->data.F32[y][x] = imageValue + sfiles->transparentStreaks; + } else { + sfiles->outImage->image->data.F32[y][x] = exciseValue; + } } } @@ -711,11 +797,10 @@ sfiles->inMask->image->data.PS_TYPE_IMAGE_MASK_DATA[y][x]; } - sfiles->outMask->image->data.PS_TYPE_IMAGE_MASK_DATA[y][x] = - sfiles->inMask->image->data.PS_TYPE_IMAGE_MASK_DATA[y][x] | newMaskValue; - } -} - -static void -exciseNonWarpedPixels(streakFiles *sfiles, psImageMaskType newMaskValue) + sfiles->outMask->image->data.PS_TYPE_IMAGE_MASK_DATA[y][x] |= newMaskValue; + } +} + +static long +exciseNonDiffedPixels(streakFiles *sfiles, psImageMaskType newMaskValue) { int cell_x0 = sfiles->astrom->cell_x0; @@ -725,4 +810,6 @@ int numCols = sfiles->inImage->numCols; // for raw images this was calculated from the width of datasec int numRows = sfiles->inImage->numRows; // for raw images this was calculated from the height of datasec + + long excisedPixels = 0; // printf("%2d x0: %4d y0: %4d xpar: %d ypar: %d\n", sfiles->extnum, cell_x0, cell_y0, xParity, yParity); @@ -739,5 +826,5 @@ } - psU8 *pixels = sfiles->warpedPixels->data.U8[yChip]; + psU8 *pixels = sfiles->diffedPixels->data.U8[yChip]; if (xParity == 1) { @@ -746,4 +833,5 @@ if (! *pixels ) { excisePixel(sfiles, xCell, yCell, false, newMaskValue); + excisedPixels++; } } @@ -755,17 +843,19 @@ if (!*pixels) { excisePixel(sfiles, xCell, yCell, false, newMaskValue); + excisedPixels++; } } } } + return excisedPixels; } static bool -warpedPixel(streakFiles *sfiles, int x, int y) +diffedPixel(streakFiles *sfiles, int x, int y) { PixelPos chipCoord; if (!CHIP_LEVEL_INPUT(sfiles->stage)) { - // if we're here on a skycell image by definition this pixel was warped + // if we're here on a skycell image by definition this pixel was diffed return true; } @@ -780,12 +870,12 @@ cellToChipInt(&chipCoord.x, &chipCoord.y, sfiles->astrom, x, y); - if (chipCoord.x < 0 || chipCoord.x >= sfiles->warpedPixels->numCols) { + if (chipCoord.x < 0 || chipCoord.x >= sfiles->diffedPixels->numCols) { return false; } - if (chipCoord.y < 0 || chipCoord.y >= sfiles->warpedPixels->numRows) { + if (chipCoord.y < 0 || chipCoord.y >= sfiles->diffedPixels->numRows) { return false; } - return psImageGet(sfiles->warpedPixels, chipCoord.x, chipCoord.y) ? true : false; + return psImageGet(sfiles->diffedPixels, chipCoord.x, chipCoord.y) ? true : false; } Index: branches/tap_branches/magic/remove/src/streaksremove.h =================================================================== --- branches/tap_branches/magic/remove/src/streaksremove.h (revision 25900) +++ branches/tap_branches/magic/remove/src/streaksremove.h (revision 27838) @@ -33,15 +33,9 @@ int yParity; double exciseValue; + psString program; } sFile; - -typedef enum { - IPP_STAGE_NONE = 0, - IPP_STAGE_RAW, - IPP_STAGE_CHIP, - IPP_STAGE_WARP, - IPP_STAGE_DIFF -} ippStage; - +// used for error messages +extern char * streaksProgram; typedef struct { @@ -64,4 +58,6 @@ sFile *inSources; sFile *outSources; + psMetadata *stats; + FILE *statsFile; psString class_id; pmFPAfile *inAstrom; @@ -71,8 +67,10 @@ pmChip *chip; // current chip pmCell *cell; // current cell - psImage *warpedPixels; + psImage *diffedPixels; psVector *tiles; double transparentStreaks; psString program_name; + psU32 maskStreak; + psU32 maskMask; } streakFiles; @@ -86,9 +84,12 @@ extern void cellToChipInt(unsigned int *xChip, unsigned int *yChip, strkAstrom *astrom, int xCell, int yCell); -extern bool computeWarpedPixels(streakFiles *sf); +extern bool computeDiffedPixels(streakFiles *sf); extern void streaksExit(psString, int); extern ippStage parseStage(psString); extern psString pathToDirectory(char *path); extern void setStreakFiles( streakFiles *); + +extern bool streaksVersionHeaderFull(psMetadata *header); +extern psString streaksVersionLong(void); #define CHIP_LEVEL_INPUT(_stage) ((_stage == IPP_STAGE_RAW) || (_stage == IPP_STAGE_CHIP)) Index: branches/tap_branches/magic/remove/src/streaksreplace.c =================================================================== --- branches/tap_branches/magic/remove/src/streaksreplace.c (revision 25900) +++ branches/tap_branches/magic/remove/src/streaksreplace.c (revision 27838) @@ -5,4 +5,6 @@ static void writeImages(streakFiles *sf, bool exciseImageCube); static bool readAndCopyToOutput(streakFiles *sf, bool restoreImageCube); + +char *streaksProgram = "streaksreplace"; int main(int argc, char *argv[]) Index: branches/tap_branches/magic/remove/src/warpedpixels.c =================================================================== --- branches/tap_branches/magic/remove/src/warpedpixels.c (revision 25900) +++ (revision ) @@ -1,330 +1,0 @@ -#include "streaksremove.h" -#include "pmAstrometryWCS.h" - -// #define DEBUG_PRINT 1 - -static void addTouchedPixels(streakFiles *sf, psString fileName); -static void nameCorners(psPlane pt[4]); -static int xLeft(psPlane *pt, int y); -static int xRight(psPlane *pt, int y); - -bool -computeWarpedPixels(streakFiles *sf) -{ - bool status; - pmConfig *config = sf->config; - - psArray *skycells = psMetadataLookupPtr(&status, config->arguments, "SKYCELLS"); - if (skycells == NULL) { - return false; - } - - int n = psArrayLength(skycells); - - psRegion *bounds = pmChipPixels(sf->chip); - - int width = bounds->x1 - bounds->x0; - int height = bounds->y1 - bounds->y0; - - psFree(bounds); - - sf->warpedPixels = psImageAlloc(width, height, PS_TYPE_U8); - psImageInit(sf->warpedPixels, 0); - - for (int i=0; iinAstrom->fpa->toSky->type != PS_PROJ_DIS) { - pmAstromWriteWCS(header, sf->inAstrom->fpa, sf->chip, 0.001); - } - psFits *fits = psFitsOpen("warpedpixels.fits", "w"); - - psFitsWriteImage(fits, header, sf->warpedPixels, 0, NULL); - psFitsClose(fits); - psFree(header); - } - return true; -} - -static void -addTouchedPixels(streakFiles *sf, psString fileName) -{ - // read fits header - psFits *fits = psFitsOpen(fileName, "r"); - if (!fits) { - psError(PS_ERR_IO, false, "failed to open skycell file: %s", fileName); - streaksExit("", PS_EXIT_DATA_ERROR); - } - psMetadata *header = psFitsReadHeader(NULL, fits); - psFitsClose(fits); - if (!header) { - psError(PS_ERR_IO, false, "failed to read fixts header from skycell file: %s", fileName); - streaksExit("", PS_EXIT_DATA_ERROR); - } - // set up astrometry for conversion from skycell image to sky - pmAstromWCS *wcs = pmAstromWCSfromHeader(header); - if (!wcs) { - psError(PS_ERR_IO, false, "failed to read astrometry from skycell file: %s", fileName); - streaksExit("", PS_EXIT_DATA_ERROR); - } - int naxis1 = psMetadataLookupS32(NULL, header, "NAXIS1"); - int naxis2 = psMetadataLookupS32(NULL, header, "NAXIS2"); - - psFree(header); - - /* now set up our wrapper to the chip astrometry to apply to the whole chip */ - sf->astrom = streakSetAstrometry(sf->astrom, sf->stage, sf->inAstrom->fpa, sf->chip, false, NULL, - sf->warpedPixels->numCols, sf->warpedPixels->numRows); - - // convert corners of skycell to sky coordinates - // compute overlap with the chip using astrometry - psPlane pt[4]; - pt[0].x = 0; - pt[0].y = 0; - - pt[1].x = naxis1 - 1; - pt[1].y = 0; - - pt[2].x = naxis1 - 1; - pt[2].y = naxis2 - 1; - - pt[3].x = 0; - pt[3].y = naxis2 - 1; - - for (int i = 0; i < 4 ; i++ ) { - psSphere sky; - - // convert corner of skycell to sky coordinates - if (!pmAstromWCStoSky(&sky, wcs, &pt[i])) { - psErrorStackPrint(stderr, "failed to convert pt %d of %s to sky coords", i, fileName); - streaksExit("", PS_EXIT_DATA_ERROR); - } - strkPt p; - // convert to chip coordinates - if (!skyToCell(&p, sf->astrom, sky.r, sky.d)) { - psErrorStackPrint(stderr, "failed to convert pt %d of %s to sky coords", i, fileName); - streaksExit("", PS_EXIT_DATA_ERROR); - } - pt[i].x = p.x; - pt[i].y = p.y; - } - - psFree(wcs); - - // put the corners in the desired order (see comments below) - - nameCorners(pt); - psString type; - if (pt[0].y < pt[2].y ) { - type = "1"; - } else { - type = "2"; - } -#ifdef DEBUG_PRINT - printf("\nSKYCELL %s Type: %s\n", fileName, type); - for (int i=0; i<4; i++) { - printf("%f %f\n", pt[i].x, pt[i].y); - } -#endif - // Now set the touched pixels - int ymin = fmax(0, pt[1].y ); - int ymax = fmin(pt[3].y + 0.5, sf->warpedPixels->numRows - 1); -#if (DEBUG_PRINT > 1) - printf("\nymin: %d ymax: %d\n", ymin, ymax); -#endif - for (int y = ymin ; y <= ymax; y++) { - int xleft = xLeft(pt, y); - int xright = xRight(pt, y); - - if (xleft < 0) { - xleft = 0; - } - if (xleft > sf->warpedPixels->numCols) { - continue; - } - if (xright < 0) { - continue; - } - if (xright >= sf->warpedPixels->numCols) { - xright = sf->warpedPixels->numCols - 1; - } -#if (DEBUG_PRINT > 1) - printf(" y: %d xleft: %d xright: %d\n", y, xleft, xright); -#endif - - psU8 *rowPixels = sf->warpedPixels->data.U8[y]; - - int n = xright - xleft + 1; - if (n > 0) { - memset(&rowPixels[xleft], 255, n); - } - } -} - -// x as a function of y for the line between two points -// Note: the caller guarentees that the y's of the two points are different -static double xOfY(psPlane *pI, psPlane *pJ, int y) -{ - double m_inv = (double) (pJ->x - pI->x) / (double) (pJ->y - pI->y); - - double x = ((double) y - pI->y) * m_inv + (double) pI->x; - - return x; -} - -static int xLeft(psPlane *pt, int y) -{ - double x_d; - if (y < pt[0].y) { - // left boundary is the line from pt 0 to pt 1 - x_d = xOfY(&pt[0], &pt[1], y); - } else { - // left boundary is the line from pt 0 to pt 3 - x_d = xOfY(&pt[0], &pt[3], y); - } - return (int) (x_d + 0.5); -} - -static int xRight(psPlane *pt, int y) -{ - double x_d; - if (y < pt[2].y) { - // right boundary is the line from pt 1 to pt 2 - x_d = xOfY(&pt[1], &pt[2], y); - - } else { - // right boundary is the line from pt 2 to pt 3 - x_d = xOfY(&pt[2], &pt[3], y); - } - return (int) x_d; -} - -/* - * To compute the overlap of a quadrilateral with a set of - * points we transform the 4 corners to image coordinates - * and name the 4 points of the quad - pt 0 is left most (bottom most corner) - pt 1 is bottom most (right most corner) - pt 2 is right most (top most corner) - pt 3 is top most (left most corner) - -* Then we can divide the quad into 3 regions A B and C based -* on the y coordinate - -* (in the degenerate case of a rectangle aligned to the axes -* we only have 1 region) -* In each of the three regions A, B, and C the test for whether a -* point is contained in the quad on scanline y is simply - - x >= xleft(y) x < xright(y) - -* where xleft(y) and xright(y) are the bounding lines at the given -* y coordinate. - -The following diagrams show some examples. The 4 points are labeled 0 to 3 -The three regions are labeld A B and C, the boundaries between the regions -ocur at pt0.y and pt2.y - -Example 1 - - 3 - C - ---------------2 left boundary: line 0_1 y < pt0.y - B line 0_3 y >= pt0.y - 0-------------- - A right boundary: line 1_2 y < pt2.y - 1 line 2_3 y >= pt.y -************************** -Example 2 - 3 - C - 0---------------- - B - ----------------2 - A - 1 - -************************** -Example 3 - - 3 2 - - B - - 0 1 - -(region A and C are empty in the case where the points form a rectangle) -*/ - -/* - Name the corners - The following algorithm works for points that form a quadrilateral - I think it also works for the situation where 3 points are co-linear - and we have a triangle, but that isn't important for our purposes - -*/ - -static void -nameCorners(psPlane pt[4]) -{ - psPlane pt0, pt1, pt2, pt3; - - /* find pt0 the left most (bottom most) corner */ - int imin = 0; - int min = (int) pt[0].x; - int i; - for (i=1; i<4; i++) { - int x = pt[i].x; - if ((x < min) || - ((x == min) && (pt[i].y < pt[imin].y))) { - imin = i; - min = x; - } - } - // remve pt0 from the list - pt0 = pt[imin]; - for (i=imin; i<3; i++) { - pt[i] = pt[i+1]; - } - - // find the bottom most (right most) corner from the remaining 3 - imin = 0; - min = pt[0].y; - for (i=1; i<3; i++) { - int y = pt[i].y; - if ((y < min) || - ((y == min) && (pt[i].x > pt[imin].x)) ) { - imin = i; - min = y; - } - } - // remve pt1 from the list - pt1 = pt[imin]; - for (i=imin; i<3; i++) { - pt[i] = pt[i+1]; - } - - // now find the right most (top most) of the remaining 2 points - if ((pt[0].x > pt[1].x) || - ((pt[0].x == pt[1].x) && (pt[0].y > pt[1].y))) { - pt2 = pt[0]; - pt3 = pt[1]; - } else { - pt2 = pt[1]; - pt3 = pt[0]; - } - /* write the outputs */ - pt[0] = pt0; - pt[1] = pt1; - pt[2] = pt2; - pt[3] = pt3; -}