Go to the source code of this file.
MQScript Auxiliary Functions | |
double | length (VariantArray array) |
Returns the length of an array. | |
double | verbose (void) |
Toggles the verbose mode. | |
double | Number_Save (double number, char *filename) |
Saves a number to a file. | |
MQScript Map2D Input/Output Functions | |
Map2D | Map_Load (char *mqf_map) |
Loads and returns a data structure of a 2D-map (Map2D). | |
Map2D | lmap (char *mqf_map) |
Short-hand version of Map_Load. | |
double | Map_Save (Map2D map, char *mqf_map) |
Saves a 2D-map (Map2D) at the location filename. | |
double | smap (Map2D map, char *mqf_map) |
Short-hand version of Map_Save. | |
double | Map_Remove (char *mqf_map) |
Deletes a 2D-map file at the location mqf_map. | |
double | rmmap (char *mqf_map) |
Short-hand version of Map_Remove. | |
MQScript Map2D Get Functions | |
double | Map_GetArea (Map2D map) |
Calculates and returns the area of the 2D-map. | |
double | Map_GetMedian (Map2D map, double mode) |
Calculates and returns the median of the abundance values for all the points in a 2D-map. | |
double | Map_GetAvgAbsDevFromValue (Map2D map, double value, double mode) |
Calculates and returns the average absolute deviation from a given value for all the abundance values of the points in a 2D-map. | |
double | Map_GetMedianAbsDevFromValue (Map2D map, double value, double mode) |
Calculates and returns the median absolute deviation from a given value for all the abundance values of the points in a 2D-map. | |
double | Map_GetMean (Map2D map, double mode) |
Calculates and returns the mean of the abundance values for all the points in a 2D-map. | |
double | Map_GetSD (Map2D map, double mean, double mode) |
Calculates and returns the standard deviation of the abundance values for all the points in a 2D-map. | |
VariantArray | Map_GetSegmentArray (Map2D map) |
Returns all the segments of a segmented map in an array. | |
VariantArray | Map_GetSegmentArrayContainingPeaks (Map2D map, VariantArray peaks, double dMZTolerance, double nScanTolerance) |
Returns only the segments of a segmented map that contain the peaks of interest. | |
MQScript Map2D Processing Functions | |
Map2D | Map_ApplyFilter (Map2D map, char *filter, double dim) |
Applies a convolution filter to a 2D-map (Map2D). | |
Map2D | filtermap (Map2D map, char *filter, double dim) |
Short-hand version of Map_ApplyFilter. | |
Map2D | Map_Segment (Map2D map, double bin_size) |
Applies the watershed algorithm to a 2D-map (Map2D). | |
Map2D | segmap (Map2D map, double bin_size) |
Short-hand version of Map_Segment. | |
Map2D | Map_ApplyOpening (Map2D map, char *structel) |
Applies a morphological opening to the 2D-map (Map2D). | |
Map2D | openmap (Map2D map, char *structel) |
Short-hand version of Map_ApplyOpening. | |
Map2D | Map_ApplyClosing (Map2D map, char *structel) |
Applies a morphological closing to the 2D-map (Map2D). | |
Map2D | closemap (Map2D map, char *structel) |
Short-hand version of Map_ApplyClosing. | |
Map2D | Map_ApplyLinearInterpolation (Map2D map) |
Applies a linear interpolation for each mass chromatogram. | |
Map2D | linintermap (Map2D map) |
Short-hand version of Map_ApplyLinearInterpolation. | |
Map2D | Map_RemoveStreaks4 (Map2D map) |
Removes the streaks from a map. | |
Map2D | rstreaks4 (Map2D map) |
Short-hand version of Map_RemoveStreaks4. | |
VariantArray | Map_FindPeaks (Map2D source, char *structel, double abuthr) |
Finds peaks in a map. | |
VariantArray | findpk (Map2D source, char *structel, double abuthr) |
Short-hand version of Map_FindPeaks. | |
Map2D | Map_Extract (Map2D source, Map2D stencil, Segment segment) |
Extracts a segment map. | |
Map2D | extractmap (Map2D source, Map2D stencil, Segment segment) |
Short-hand version of Map_Extract. | |
MQScript Peak Related Functions | |
VariantArray | PeakArray_Load (char *mqf_pk) |
Loads a peak series. | |
VariantArray | lpk (char *mqf_pk) |
Short-hand version of PeakArray_Load. | |
double | PeakArray_Print (VariantArray array) |
Prints a peak series. | |
double | PeakArray_Save (VariantArray array, char *mqf_pk) |
Saves a peak series. | |
double | PeakArray_SaveWithMapValue (VariantArray array, Map2D map, char *mqf_pk) |
Saves a peak series with value in map. | |
double | PeakArray_SavePhysQuantWithMapValue (VariantArray array, Map2D map, char *mqf_pk) |
Saves a peak series using their physical quantity values (time and m/z) and the intensity value. | |
double | PeakArray_SaveWithBaseline (VariantArray array, Map2D map, char *mqf_pk) |
Saves a peak series with baseline values. | |
MQScript FPeak Related Functions | |
VariantArray | FPeakArray_Load (char *mqf_fpk) |
Loads a fpeak series. | |
VariantArray | lfpk (char *name) |
Short-hand version of FPeakArray_Load. | |
double | FPeakArray_Print (VariantArray array) |
Prints an array of type FPeak2i to standard output. | |
VariantArray | FPeakArray_GetPeaksNotInPeakGroup (VariantArray pFPeaksAll, PeakGroup peakgroup) |
Returns the subset of fpeaks from a set of fpeaks, that do not belong to a particular peakgroup. | |
VariantArray | FPeakArray_GetPeakArray (VariantArray array) |
Converts an array of type FPeak2i to an array of type Peak2i. | |
Map2D | FPeakArray_CreateMapFrom (VariantArray array, Map2D template_map) |
Creates a map from an array of peaks of type FPeak2i. | |
MQScript Segment Related Functions | |
Segment | Segment_FindAndFitPeaks (Segment segment, Map2D map, char *structel, double abuthr, char *curve) |
Finding and fitting peaks in a 2D-map. | |
Map2D | Segment_GetMap (Segment segment, Map2D source, Map2D mask) |
Extracts a segment map. | |
double | Segment_Save (Segment segment, char *mqf_fpk) |
Saves a Segment in a file mqf_fpk. | |
double | Segment_Print (Segment segment) |
Prints a Segment to standard output. | |
VariantArray | Segment_GetFPeaks (Segment segment) |
Gets the FPeak2i array from a Segment. | |
VariantArray | SegmentArray_Load (char *mqf_fpk) |
Loads an array of type Segment. | |
double | FPeakFile_WriteHeader (char *szFilename, Map2D source, char *curve, double nsegments) |
Saves the header of a fpeaks file. | |
double | FPeakFile_CalcStatAndSave (char *mqf_fpk) |
Calculates and saves the statistics of attributes of the fpeaks. | |
MQScript PeakGroup Related Functions | |
VariantArray | PeakGroupArray_Load (char *mqf_pgr) |
Loads a peakgroup array from a pgroups file. | |
VariantArray | lpg (char *mqf_pgr) |
Short-hand version of PeakGroupArray_Load. | |
double | PeakGroup_Print (PeakGroup peakgroup) |
Prints a PeakGroup in standard out. | |
double | PeakGroup_Save (PeakGroup peakgroup, char *filename, double type) |
Saves a PeakGroup in a file. | |
VariantArray | PeakGroup_GetFPeaks (PeakGroup peakgroup) |
Gets the FPeak2i array from a PeakGroup. | |
VariantArray | getfpk (PeakGroup peakgroup) |
Short-hand version of PeakGroup_GetFPeaks. | |
PeakGroup | PeakGroup_Create (VariantArray array) |
Creates a peakgroup. | |
PeakGroup | mkpg (VariantArray array) |
Short-hand version of PeakGroup_Create. | |
VariantArray | PeakGroupArray_GetFPeaks (VariantArray pg_array) |
Gets the FPeak2i array from a PeakGroup array. | |
VariantArray | vgetfpk (VariantArray pg_array) |
Short-hand version of PeakGroupArray_GetFPeaks. | |
Map2D | getpgmap (PeakGroup peakgroup, Map2D source, Map2D stencil) |
Returns the peakgroup map of a peakgroup. | |
VariantArray | getpgmappeaks (PeakGroup peakgroup, char *mqf_fpk) |
Returns the fpeaks that are found in a peakgroup map. | |
double | PeakGroupFile_WriteHeader (char *mqf_fpk, char *type, char *curve, double npg, double npeaks) |
Saves the header of a pgroups file. | |
MQScript FPeak Clustering Related Functions | |
double | FPeakFile_ClusterAndSave (char *mqf_fpk_in, char *mgf_pgr_out, double scan_thr, double mz_thr, double abund_thr, double nLinkageType) |
Clusters fpeaks (FPeak2i) into co-eluting peakgroups (PeakGroup). | |
double | PeakGroupFile_ClusterAndSave (char *mgf_pgr_in, char *mgf_pgr_out, double scan_thr, double mz_thr, double abund_thr, double nLinkageType) |
Clusters fpeaks (FPeak2i) iteratively in each PeakGroup of a PeakGroup array. | |
MQScript SegmentHandler Related Functions | |
SegmentHandler | SegmentHandler_Init (char *peakgroupfilename) |
SegmentHandler | SegmentHandler_Set (SegmentHandler seghand, PeakGroup peakgroup) |
Map2D | SegmentHandler_GetMap (SegmentHandler seghand, PeakGroup peakgroup) |
VariantArray | SegmentHandler_GetMapPeaks (SegmentHandler seghand, PeakGroup peakgroup) |
MQScript PeakGroup Refining/Deconvolving Functions | |
PeakGroup | PeakGroup_Refine7 (PeakGroup peakgroup, Map2D PGMap, VariantArray pPGOutFPeaks, char *struct_elem, double abu_thr, char *curve, double scan_window, double mz_overlap_thr) |
Deconvolves overlapping fpeaks in a PeakGroup. | |
PeakGroup | refine7 (PeakGroup peakgroup, Map2D PGMap, VariantArray pPGOutFPeaks, char *struct_elem, double abu_thr, char *curve, double scan_window, double mz_overlap_thr) |
Short-hand version of PeakGroup_Refine7. | |
PeakGroup | PeakGroup_Deconv3 (PeakGroup peakgroup, Map2D PGMap, VariantArray pPGOutFPeaks, char *curve) |
Deconvolves the PeakGroup into IsotopicClusters using fitting. | |
PeakGroup | deconv3 (PeakGroup peakgroup, Map2D PGMap, VariantArray pPGOutFPeaks, char *curve) |
Short-hand version of PeakGroup_Deconv3. | |
PeakGroup | PeakGroup_Deconv4 (PeakGroup peakgroup) |
Deconvolves the PeakGroup into IsotopicClusters without using fitting. | |
PeakGroup | deconv4 (PeakGroup peakgroup) |
Short-hand version of PeakGroup_Deconv4. | |
MQScript Manual/Visual Fitting Related Functions | |
double | fixmz (void) |
double | fixz (void) |
double | fixc (void) |
double | fixsmz (void) |
double | setsmz (double index, double value) |
double | clrfitter (void) |
double | commonsmz (void) |
VariantArray | fit (double init_sigma_rt, double init_sigma_mz) |
VariantArray | fitsmz (double init_sigma_rt, double smz_begin, double smz_end, double delta_sigma_mz) |
VariantArray | fitpep (double charge, double carbons) |
double | sfpk (VariantArray array, char *mqf) |
MQScript Visualization Related Functions | |
double | plotmap (Map2D map) |
Plots a variable of type Map2D. | |
double | overlaymap (Map2D map) |
Overlays the segment boundaries of a labelled map on a grayscale map. | |
double | plotpk (VariantArray array) |
Plots an array of peaks, either of type Peak2i or FPeak2i. | |
double | plotpg (VariantArray array) |
Plots an array of peakgroups. | |
double | plotseqsum (char *filename, char *which) |
Plots the sequest hits summarized in a seqsum file. | |
double | movepk (double handle, double dx) |
Moves the rendering of the peaks stored at the given handle position. | |
double | plotmqsqmap (char *filename) |
Plots the contents of an mqsqmap file. | |
double | plotms2 (char *ms2_exp_name) |
Plots all the ms/ms (sequencing events) on the map. | |
double | coversegments (VariantArray peak_array, double mz_threshold, double scan_theshold) |
Covers the segments that overlap with any of the rectangles surrounding the array of peaks. | |
double | coversegmentsonedge (void) |
Covers the segments that touch the top and bottom edges of a Map2D. | |
double | showlabels (void) |
Plots the label number of each segment. | |
double | axes (void) |
Toggles the values of the axes from sampling coordinates to physical quantities. | |
double | grid (void) |
Toggles the view of the grid. | |
double | zoomin (double x1, double x2, double y1, double y2) |
Zooms in the required rectangle. | |
double | setgraylevel (char *level) |
Sets the graylevel of the map. | |
double | goscan (double scan) |
Displays the mass spectrum of that scan. | |
double | show (double handle, char *field) |
Shows. | |
double | hide (double handle) |
Hides. | |
double | clear (double handle) |
Clears. | |
MQScript Other Functions | |
Map2D | extractseam (Map2D smap1, Map2D smap2, Map2D lmap1, Map2D lmap2) |
double | tilefpeakfile (char *mqf_fpk, char *mqf_pgf) |
char * | print (char *string) |
char * | int2str (double number, double width) |
double | setfilter (char *filter) |
double | createMS2table (char *expmntname) |
double | printZoomBoundaries (void) |
double | auxExtractMapShown (char *filename) |
double | auxExtractMap (Map2D map, double x1, double x2, double y1, double y2, char *filename) |
double | PrintFPeaksArrayInfo (VariantArray fpeaks, double parameter) |
double | PeakArray_SaveDTAPositionsWithSequence (char *szSequestSummaryName, char *szSExperimentName, char *szQExperimentName, char *szOutputfile) |
VariantArray | PeakArray_GetDTAPositions (char *szSequestSummaryName, char *szSExperimentName, char *szQExperimentName) |
double | MS2GuidedQuantitation (Map2D map, double bin_width) |
|
Toggles the values of the axes from sampling coordinates to physical quantities. This function when called requires that window that has a map already plotted in it |
|
Clears.
|
|
Covers the segments that overlap with any of the rectangles surrounding the array of peaks. This function when called requires that window that has a grayscale map already plotted in it
|
|
Covers the segments that touch the top and bottom edges of a Map2D. This function when called requires that window that has a grayscale map already plotted in it |
|
Creates a map from an array of peaks of type FPeak2i.
|
|
Converts an array of type FPeak2i to an array of type Peak2i. Returns an array of type Peak2i that was generated by stripping all the fitting parameters from each peak of type FPeak2i from the variable array
|
|
Returns the subset of fpeaks from a set of fpeaks, that do not belong to a particular peakgroup. This function returns an array of type FPeak2i as a subset from the fpeak array defined by the variable pFPeaksAll, that do not belong to the PeakGroup varaible peakgroup
|
|
Loads a fpeak series. Loads and returns an array of fpeaks (FPeak2i)
|
|
Prints an array of type FPeak2i to standard output.
|
|
Calculates and saves the statistics of attributes of the fpeaks. This function loads an array of FPeak2i from a fpeaks file given as mqf_fpk. It then calculates and saves the statistics of attributes of the fpeaks into a file with the same name as mqf_fpk but replacing the extention to metrics
|
|
Clusters fpeaks (FPeak2i) into co-eluting peakgroups (PeakGroup). This function reads the fpeaks from the file szInFilename, clusters them into peak groups and then outputs them into the file szOutFilename. The arguments scan_thr is used to set the scan tolerance of the co-elution restriction mentioned above. Likewise the argument mz_thr is used to set the m/z tolerance for the maximum allowed distance between two isotopic peaks.
|
|
Saves the header of a fpeaks file.
|
|
Returns the peakgroup map of a peakgroup. The peakgroup map of peakgroup is defined as the union of all the segment maps that contain the fpeaks found in the peakgroup itself. Segment maps are extracted as in the function Map_Extract using a Map2D as a source and a Map2D as stencil.
|
|
Returns the fpeaks that are found in a peakgroup map. This function loads all the fpeaks (FPeak2i) from the file mqf_fpk and returns the all fpeaks that are found in the segments that comprise the corresponding peakgroup 2D-map defined by peakgroup. The peakgroup map of PeakGroup is defined as the union of all the segment maps that contain the fpeaks found in the peakgroup itself.
|
|
Displays the mass spectrum of that scan. This function when called requires that window that has a grayscale map already plotted in it
|
|
Toggles the view of the grid. This function when called requires that window that has a map already plotted in it |
|
Hides.
|
|
Returns the length of an array. Returns the length of a VariantArray
|
|
Applies a morphological closing to the 2D-map (Map2D). Morphological closing is an image operation that is used to fill in the holes for groups of points (pixels) whose connectivity is defined by the structuring element given in structel
|
|
Applies a convolution filter to a 2D-map (Map2D). Saves a 2D-map (Map2D) as the name of variable filename indicates
|
|
Applies a linear interpolation for each mass chromatogram. Applies a linear interpolation for each mass chromatogram for scans that are not MS, i.e. dependent scans
|
|
Applies a morphological opening to the 2D-map (Map2D). Morphological opening is an image operation that is used to select for groups of points (pixels) whose connectivity is defined by the structuring element given in structel
|
|
Extracts a segment map. A function that excises and returns a sub Map2D from a source Map2D whose borders are defined by the rectangle that circumscribes the Segment in query. The function uses the Map2D mask as a stencil.
|
|
Finds peaks in a map. A function that finds and returns an array of Peak2i. It uses the structuring element structel and the noise threshold abuthr
|
|
Calculates and returns the area of the 2D-map. Calculates the area of the map using the SCAN_SIZE and BIN_SIZE values
|
|
Calculates and returns the average absolute deviation from a given value for all the abundance values of the points in a 2D-map. Calculates the average absolute deviation from a given value for the values int the abundance matrix of the 2D-map, either by including zeros values or excluding them.
|
|
Calculates and returns the mean of the abundance values for all the points in a 2D-map. Calculates the statistical mean of the abundance matrix of the 2D-map, either by including zeros values or excluding them.
|
|
Calculates and returns the median of the abundance values for all the points in a 2D-map. Calculates the statistical median of the abundance matrix of the 2D-map, either by including zeros values or excluding them.
|
|
Calculates and returns the median absolute deviation from a given value for all the abundance values of the points in a 2D-map. Calculates the median absolute deviation from a given value for the values int the abundance matrix of the 2D-map, either by including zeros values or excluding them.
|
|
Calculates and returns the standard deviation of the abundance values for all the points in a 2D-map. Calculates the standard deviation of the abundance matrix of the 2D-map, either by including zeros values or excluding them.
|
|
Returns all the segments of a segmented map in an array. When a 2D-map is segmented using watershed segmentation, information of the boundaries of each segment are stored internally in an array of type Segment
|
|
Returns only the segments of a segmented map that contain the peaks of interest. Similar to the function Map_GetSegmentArray but restricting it to the segments that are found within the areas defined by the rectangles defined by the parameters dMZTolerance and nScanTolerance
|
|
Loads and returns a data structure of a 2D-map (Map2D). Loads and returns a data structure of a 2D-map (Map2D). The filename should can also be in the MQScript convention format
|
|
Deletes a 2D-map file at the location mqf_map. Saves a 2D-map (Map2D) as the name of variable filename indicates
|
|
Removes the streaks from a map. Removes streaks from a Map2D structure by subtracting the median value of each mass chromatogram from all the points in the mass chromatogram
|
|
Saves a 2D-map (Map2D) at the location filename. Saves a 2D-map (Map2D) as the name of variable filename indicates
|
|
Applies the watershed algorithm to a 2D-map (Map2D). This function takes the 2-D map map and segments it using the watershed algorithm. The watershed algorithm is a segmentation algorithm that divides the map into regions where the signal is concentrated thus rendering the analysis of the map easier. The parameter bin_size is used to denote the ion abundance stepping size used by the flooding procedure of the watershed algorithm. The function returns a 2-D map that can be used a mask, since each of its data points holds the segment number in which it belongs to. It returns an array of type Segment.
|
|
Moves the rendering of the peaks stored at the given handle position. This function when called requires that window that has a grayscale map already plotted in it
|
|
Saves a number to a file. Saves a number (in append mode) to the file named filename.
|
|
Overlays the segment boundaries of a labelled map on a grayscale map. This function when called requires that window that has a grayscale map already plotted in it
|
|
Loads a peak series. Loads a plain peak series (Peak2i) into an array data structure
|
|
Prints a peak series. Prints an array of type Peak2i in standard out
|
|
Saves a peak series. Saves a peak series in a file
|
|
Saves a peak series using their physical quantity values (time and m/z) and the intensity value. Saves a peak series as 3-column table in a file. The columns in the file are the following: 1. retention time of the peak 2. m/z of the peak 3. abundance in map of that (rt, m/z) point
|
|
Saves a peak series with baseline values. Saves a peak series as 4-column table in a file. The columns in the file are the following: 1. retention time of the peak 2. m/z of the peak 3. scan position defining the left shoulder of the peak 4. scan position defining the right shoulder of the peak
|
|
Saves a peak series with value in map. Saves a peak series as 3-column table in a file. The columns in the file are the following: 1. scan position of the peak 2. m/z bin position of the peak 3. abundance in map at that (scan, m/z bin) point
|
|
Creates a peakgroup.
|
|
Deconvolves the PeakGroup into IsotopicClusters using fitting.
|
|
Deconvolves the PeakGroup into IsotopicClusters without using fitting.
|
|
Gets the FPeak2i array from a PeakGroup.
|
|
Prints a PeakGroup in standard out.
|
|
Deconvolves overlapping fpeaks in a PeakGroup.
|
|
Saves a PeakGroup in a file.
|
|
Gets the FPeak2i array from a PeakGroup array.
|
|
Loads a peakgroup array from a pgroups file.
|
|
Clusters fpeaks (FPeak2i) iteratively in each PeakGroup of a PeakGroup array.
|
|
Saves the header of a pgroups file.
|
|
Plots a variable of type Map2D. When this function if called from the mqshell a new window pops-up showing the map in grayscale
|
|
Plots the contents of an mqsqmap file. This function when called requires that window that has a grayscale map already plotted in it
|
|
Plots all the ms/ms (sequencing events) on the map. This function when called requires that window that has a grayscale map already plotted in it
|
|
Plots an array of peakgroups. This function when called requires that window that has a grayscale map already plotted in it
|
|
Plots an array of peaks, either of type Peak2i or FPeak2i. This function when called requires that window that has a grayscale map already plotted in it
|
|
Plots the sequest hits summarized in a seqsum file. This function when called requires that window that has a grayscale map already plotted in it
|
|
Finding and fitting peaks in a 2D-map.
Peak-finding
Peak-fitting
|
|
Gets the FPeak2i array from a Segment.
|
|
Extracts a segment map. Same as Map_Extract
|
|
Prints a Segment to standard output.
|
|
Saves a Segment in a file mqf_fpk.
|
|
Loads an array of type Segment.
|
|
Sets the graylevel of the map. This function when called requires that window that has a grayscale map already plotted in it
|
|
Shows.
|
|
Plots the label number of each segment. This function when called requires that window that has a grayscale map with an stencil map overlayed on top of it already plotted in it |
|
Toggles the verbose mode. If called the verbose mode will be turned off or on according to the current state |
|
Zooms in the required rectangle. This function when called requires that window that has a grayscale map already plotted in it The filename uses the MapQuant naming convention
|