file statistics

file statistics

The file statistics module is used to check the format of .apdv, .aidv, .geo, .gmf, .vdf, and .pgf files, and to calculate and display statistics about the data contained in these files. This module also calculates a frequency distribution of properties in the file. During execution, file statistics reads the file, displays an error message if the file contains errors in format or numeric values, and then displays the statistical results in the EVS Information window.

Ports

DirectionNameTypeDescription
InputInput FilenameStringFile used to display data.
InputInput Z ScaleNumberThe factor for vertical scaling.
OutputOutput FilenameStringFile used to display data.
OutputOutput Z ScaleNumberThe factor for vertical scaling.
OutputSample DataFieldA field containing the sample point data.
OutputSample ObjectRenderableA renderable object displaying the sample data.
OutputMean LevelNumberThe calculated mean value.
OutputMedian LevelNumberThe calculated median value.
OutputMinimum LevelNumberThe calculated minimum value.
OutputMaximum LevelNumberThe calculated maximum value.
OutputNumber Of PointsNumberThe input number of points.
OutputStatisticsStringString representing the calculated statistics.

Properties

PropertyTypeDescription
Allow RunBooleanThis toggle can prevent the module from running. Allowing the user to make changes to large data sets without waiting for updates.
ExecuteButtonThis button will force the module to run even if the Allow Run toggle has been turned off. This allows the user to make a number of changes before updating.
FilenameFileThe file name to process for display.
Use Application OriginBooleanWhen true, the module will apply the Application Origin. When false, data will be left in internal model space. Turn off when loading data intended to use as a glyph or similar.

Data Processing

PropertyTypeDescription
Component Or LayerIntegerThe Data Component is used to select which file data component to process for display.
Data ProcessingChoice: Linear Processing, Log ProcessingData Processing will allow the module to be run in either Linear or Log Space.
Z ScaleDoubleThe Z Scale is the vertical exaggeration to be applied to the output object.
Log Post Processing Clip MinDoublePost Processing Clip Min will be used after data processing to replace any sample property value that is less than the specified number in log space.
Linear Post Processing Clip MinDoubleLinear Post Processing Clip Min will be used after data processing to replace any sample property value that is less than the specified number in linear space.
Detection LimitDoubleThe Detection Limit value affects any file values set with the ‘ND’ or other non-detect flags. When the module encounters this flag in the file it will insert a value equal to (Detection Limit * LT Multiplier).
Less Than MultiplierDoubleThe Less Than Multiplier is the value applied to any sample with the ‘<’ less than flag.
Number Of BinsIntegerThe Number of Bins value allows the user to specify the bins that will be used to calculate the frequency histogram. The default value of 0 does not calculate a frequency distribution during execution of the module. The user can select any number of bins from 2 to 255 (note that a value of 1 is not valid).
DelimiterStringThe Delimiter specifies how the labels and values in the Output Log are separated. The word TAB will be replaced by a tab advancement.
Coordinate PrecisionIntegerThe Coordinate Precision is the number of decimal points to use for coordinate values.
Format DataNumber FormattingThe Format Data control allows the user to set how data will be formatted for display.
Detailed StatisticsBooleanThe Detail Statistics toggle causes the module to display the original statistical information along with more detailed statistics.

Glyph Settings

PropertyTypeDescription
Points As GlyphsBooleanThe Points As Glyphs toggle will cause the points to be displayed as a user selected glyph.
Point WidthIntegerThe Point Width sets the size of the rendered pixels. The default is 0 which is equivalent to 1.
Glyph SizeDoubleThe Glyph Size value is used to scale the glyphs in all directions. The default is automatically computed based on your input data.
PriorityChoice: Maximum, MinimumThe Priority of the glyph will reverse the scaling so that the smallest sample values have the largest size.
Minimum Scale FactorDoubleThe Minimum Scale Factor scales the sample values with the least Priority.
Maximum Scale FactorDoubleThe Maximum Scale Factor scales the sample values with the greatest Priority.
Use Log DataBooleanThe Use Log Data toggle will force the size of the glyph to be based on the log10 of the selected data.
Generated GlyphChoice: Sphere, Cube, Cone, Cylinder, Polygon, DiskThe Generated Glyph choice allows the user to select the type of glyph that is automatically generated.
Sphere SubdivisionsIntegerThe Sphere Subdivisions defines how finely the sample spheres are rendered. Higher values mean smoother spheres but at a higher memory cost.
Glyph ResolutionIntegerThe resolution for generated cone, polygon, cylinder, and disk glyphs.
Primary Axis FactorDoubleThe scale factor for the primary axis of the glyph.
Secondary Axis FactorDoubleThe scale factor for the secondary axis of the glyph.
Heading DipHeading/DipThe Heading and Dip values are used to align the glyphs to a constant orientation.
RollDoubleThe roll of the glyph along its primary axis.

Time Settings

PropertyTypeDescription
Chem File Is Time DomainBooleanThe Chem File is Time Domain toggle turns on date interpolation for time domain analyte (e.g. chemistry) files.
Specify Date By ComponentBooleanThe Specify Date by Component toggle will cause the Date field to be ignored and the date to be selected using the Data Component.
Date For InterpolationDateThe Date For Interpolation field is the date being interpolated to. The Date can be either set here or passed in via the Date port.
Analyte NameStringThe Analyte Name field is used for AIDV and APDV time files as the dates take up the spots in these files usually reserved for analyte names.
Interpolation TypeChoice: Direct Interpolation Only, Interpolate Only, Interpolate and Extrapolate Beyond, Interpolate and Extrapolate, Interpolate (Use with Shrink)There are 5 different Interpolation Methods that are available, each interpolation method is used to define how to interpolate when given non-detects in a file.
Use Nearest Measured DataBooleanThe Use Nearest Measured Data toggle causes the sample at the interpolated date, to have the same value as the nearest measured date and not an interpolated value.
Non Linear ShrinkBooleanIf the Non-Linear Shrink toggle is selected the size of the sphere will be determined by a cosine interpolation instead of a linear one.