<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE knimeNode PUBLIC "-//UNIKN//DTD KNIME Node 2.0//EN" "http://www.knime.org/Node.dtd">
<knimeNode icon="generic_node.png" type="Manipulator">
    <name>MapAlignerPoseClustering</name>
    
    <shortDescription>
        Corrects retention time distortions between maps using a pose clustering approach.
    </shortDescription>
    
    <fullDescription>
        <intro><p>Corrects retention time distortions between maps using a pose clustering approach.</p>
		<p>
			<a href="http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_MapAlignerPoseClustering.html">Web Documentation for MapAlignerPoseClustering</a>
		</p>

        </intro>
        
		<option name="version">Version of the tool that generated this parameters file.</option>
		<option name="log">Name of log file (created only when specified)</option>
		<option name="debug">Sets the debug level</option>
		<option name="threads">Sets the number of threads allowed to be used by the TOPP tool</option>
		<option name="no_progress">Disables progress logging to command line</option>
		<option name="force">Overwrite tool specific checks.</option>
		<option name="test">Enables the test mode (needed for internal use only)</option>
		<option name="index">Use one of the input files as reference ('1' for the first file, etc.).
If '0', no explicit reference is set - the algorithm will select a reference.</option>
		<option name="max_num_peaks_considered">The maximal number of peaks/features to be considered per map. To use all, set to '-1'.</option>
		<option name="mz_pair_max_distance">Maximum of m/z deviation of corresponding elements in different maps.  This condition applies to the pairs considered in hashing.</option>
		<option name="rt_pair_distance_fraction">Within each of the two maps, the pairs considered for pose clustering must be separated by at least this fraction of the total elution time interval (i.e., max - min).  </option>
		<option name="num_used_points">Maximum number of elements considered in each map (selected by intensity).  Use this to reduce the running time and to disregard weak signals during alignment.  For using all points, set this to -1.</option>
		<option name="scaling_bucket_size">The scaling of the retention time interval is being hashed into buckets of this size during pose clustering.  A good choice for this would be a bit smaller than the error you would expect from repeated runs.</option>
		<option name="shift_bucket_size">The shift at the lower (respectively, higher) end of the retention time interval is being hashed into buckets of this size during pose clustering.  A good choice for this would be about the time between consecutive MS scans.</option>
		<option name="max_shift">Maximal shift which is considered during histogramming (in seconds).  This applies for both directions.</option>
		<option name="max_scaling">Maximal scaling which is considered during histogramming.  The minimal scaling is the reciprocal of this.</option>
		<option name="dump_buckets">[DEBUG] If non-empty, base filename where hash table buckets will be dumped to.  A serial number for each invocation will be appended automatically.</option>
		<option name="dump_pairs">[DEBUG] If non-empty, base filename where the individual hashed pairs will be dumped to (large!).  A serial number for each invocation will be appended automatically.</option>
		<option name="second_nearest_gap">Only link features whose distance to the second nearest neighbors (for both sides) is larger by 'second_nearest_gap' than the distance between the matched pair itself.</option>
		<option name="use_identifications">Never link features that are annotated with different peptides (features without ID's always match; only the best hit per peptide identification is considered).</option>
		<option name="ignore_charge">false [default]: pairing requires equal charge state (or at least one unknown charge '0'); true: Pairing irrespective of charge state</option>
		<option name="max_difference">Never pair features with a larger RT distance (in seconds).</option>
		<option name="exponent">Normalized RT differences ([0-1], relative to 'max_difference') are raised to this power (using 1 or 2 will be fast, everything else is REALLY slow)</option>
		<option name="weight">Final RT distances are weighted by this factor</option>
		<option name="max_difference">Never pair features with larger m/z distance (unit defined by 'unit')</option>
		<option name="unit">Unit of the 'max_difference' parameter</option>
		<option name="exponent">Normalized ([0-1], relative to 'max_difference') m/z differences are raised to this power (using 1 or 2 will be fast, everything else is REALLY slow)</option>
		<option name="weight">Final m/z distances are weighted by this factor</option>
		<option name="exponent">Differences in relative intensity ([0-1]) are raised to this power (using 1 or 2 will be fast, everything else is REALLY slow)</option>
		<option name="weight">Final intensity distances are weighted by this factor</option>

    </fullDescription>
    
    <ports>
		<inPort index="0" name="in [mzML,featureXML]">Input files to align (all must have the same file type) [mzML,featureXML]</inPort>
		<inPort index="1" name="file [mzML,featureXML]">File to use as reference (same file format as input files required) [mzML,featureXML,opt.]</inPort>
		<outPort index="0" name="out [mzML,featureXML,Inactive]">Output files (same file type as 'in'). Either this option or 'trafo_out' has to be provided; they can be used together. [mzML,featureXML,Inactive]</outPort>
		<outPort index="1" name="trafo_out [trafoXML,Inactive]">Transformation output files. Either this option or 'out' has to be provided; they can be used together. [trafoXML,Inactive]</outPort>
 </ports>
    <views>
        <view index="0" name="MapAlignerPoseClustering Std Output">The text sent to standard out during the execution of MapAlignerPoseClustering.</view>
        <view index="1" name="MapAlignerPoseClustering Error Output">The text sent to standard error during the execution of MapAlignerPoseClustering. (If it appears in gray, it's the output of a previously failing run which is preserved for your trouble shooting.)</view>
    </views>    
</knimeNode>
