Deprecated version - (ManageLithoInversion) - syntax is described below, but this is now on the way out!!
New tool, using GOOGLE protobuf message parsing and a "task" file syntax
see the schema and formal definition in invtaskmodel.proto
Version:2.0
Build:1435
Date:3 Mar 2011
All commands are prefaced by the name of the executable, ManageLithoInversion. The parent directory of the licensed GeoModeller
Installation must be on the path as well as the client subdirectory (For 32bit Windows) and the server subdirectory (For 64bit Windows)
1. Case and Run management
============================
NewCase (Create a new case from a GeoModeller project)
syntax: <Project> NewCase <CaseDir> <ZCELLSIZE> <ElevationMIN_VOXET> <ElevationMAX_VOXET> <MEASURED_GRIDS_LIST> <ResultsDir>
<Project> = the relative (or absolute) path and Project name for the source GeoModeller Project
<CaseDir> = the relative (or absolute) path of the directory that will host the Case files
<ElevationMIN_VOXET> = Elevation of the base of the bottom Voxels
Auto means go to bottom of project extent)
.Centroid will be ZCELLSIZE/2 above this.
<ElevationMAX_VOXET> = Elevation of the top of the top Voxel (Auto means go to top of project extent)
<MEASURED_GRIDS_LIST> = <MEASURED_GRID_DESC(1)> ... <MEASURED_GRID_DESC(N)>
and <MEASURED_GRID_DESC> = <GEOPHYSICS_TYPE> <MEAN_ELEVATION> <PRECISION>
<MatchTrend> <MatchTrendDegree> <MatchTrendRate> <GEOPHYSICS_GRID>
<MatchTrend> = <0 | 1> (To adjust the trend of the observed data to match the trend in the calculated data)
<MatchTrendDegree> = <0 | 1 | 2 | 3> (Polynomial degree of the trend)
<MatchTrendRate> = <rate> where rate=0 means do only once and rate>0 specifies the iteration interval between adjustments
<ResultsDir> = <Existing output parent directory for CaseDir>
Z will range from ElevationMAX_VOXET - NZ * ZCELLSIZE (the bottom of the bottom voxel) to ElevationMAX_VOXET (the top of the top voxel)
Where NZ = Number of elevations in voxet such that
ElevationMAX_VOXET - NZ * ZCELLSIZE >= ElevationMIN_VOXET and
ElevationMAX_VOXET - (NZ + 1) * ZCELLSIZE > ElevationMIN_VOXET
NewForwardCase (Create a new case for use in Forward modelling)
syntax: <Project> NewForwardCase <CaseDir> <eCELLSIZE> <nCELLSIZE> <zCELLSIZE> <EastMIN_VOXET> <EastMAX_VOXET> <NorthMIN_VOXET> <NorthMAX_VOXET> <ElevationMIN_VOXET> <ElevationMAX_VOXET> <MEAN_ELEVATION> <GEOPHYSICS_TYPE_LIST> <ResultsDir>
The easting will range from EastMIN_VOXET (the western edge of the most western voxels) to EastMIN_VOXET+NEAST*eCELLSIZE (the eastern edge of the most eastern voxels)
Where NEAST=Number of voxels in the easting direction such that
EastMIN_VOXET+(NEAST-1)*eCELLSIZE < EastMAX_VOXET and
EastMIN_VOXET+NEAST*eCELLSIZE >= EastMAX_VOXET
The northing will range from NorthMIN_VOXET (the southern edge of the most southern voxels) to NorthMIN_VOXET+NNORTH*nCELLSIZE (the northern edge of the most northern voxels)
Where NNORTH=Number of voxels in the northing direction such that
NorthMIN_VOXET +(NNORTH-1)* nCELLSIZE < NorthMAX_VOXET and
NorthMIN_VOXET + NNORTH * nCELLSIZE >= NorthMAX_VOXET
CreateCaseFromVoxet (Create a new case from an external voxet for use in Temperature Forward modelling)
syntax: CreateCaseFromVoxet <InputVoxet> <CaseXML> <GEOPHYSICS_TYPE> <Formation1> … <FormationN>
Create a new case consisting of a GeoModeller project with extents corresponding to InputVoxet and a horizontal topographic surface at the top of the voxet.
A set of formations are created so that the label “Formation1” will correspond to Index values of 1 in the voxet and the label “Formation2” will correspond to Index values of 2 in the voxet and so on.
The new case is created with a dummy Observed grid with origins and cellsizes corresponding to that of the X,Y origins and cellsizes of the InputVoxet.
This new case is intended for temperature forward modelling only. See ForwardModelTemperatureForCreateCaseFromVoxet.
CaseControl
syntax: <CaseXML> CaseControl <ARGLIST>
ARGLIST=SetLaw <Formation> <PROPERTY> <LAW>
where LawChangeList = <LawChange1 ... LawChangeN>
and LawChange = <Formation> <PROPERTY> <LAW>
where <PROPERTY>=<Density | Susceptibility | Remanence | CommonalityVolume |
Commonality | ShapeRatio | VolumeRatio | Movable | Index | ThermalConductivity | HeatProductionRate>
eg. SetLaw F1 Density Normal(2.66,0.1,100)
eg. SetLaw F1 Density "Normal(2.67,0.01,95) + Normal(3.67,0.01,5)"
eg. SetLaw F1 Remanence Normal(0.3,0.1,100,45,89) where the inclination is 45 and the declination is 89eg. SetLaw F1 Density “Normal(2.67,0.0001,100,XYZ, F1_Densities.vo,Density)”
where the field Density in the voxet F1_Densities.vo controls the mean of the distribution at every voxeleg. SetLaw F1 Density “Normal(2.67,0.0001,100,XY, F1_Densities.ers)”
where the values in the ERMapper grid F1_Densities.ers provide 2D plan view control of the variable mean of the distribution.eg. SetLaw F1 CommonalityVolume LogNormal(0,5) where Commonality units are in percentages
eg. SetLaw F1 Commonality Rayleigh(0.05)
eg. SetLaw F1 Commonality Weibull(lambda,kappa)
where lambda (>0) and kappa (>=0) define the PDF for the CommonalityMisfit function
eg. SetLaw F1 Commonality Weibull(0.3,1.0)
eg. SetLaw F1 Movable 1 (default 1)where Movable is either 0 (fixed) or 1 (movable)
eg. SetLaw F1 Index 2
where Index (2) is the index used in the voxet to represent formation F1
eg. SetLaw F1 PreserveVerticalRelationship (0,1,1,1,1,1,1,1)
where 1 means the vertical relationship between F1 and the n th formation is to be preserved and the n th formation means the n th formation as determined by age (1 as the youngest)
The formation given by the "row name" cannot be allowed to occur below any formation that has a 1 in the PreserveVerticalRelationship array. A "normal" pile ordering is achieved with ones in the upper triangle (assuming the assignments are given as a sequence from youngest to oldest). An “overturned” structure may be maintained with a 1 in the lower triangle. It is not possible to maintain BOTH normal and overturned relationships in the same project! A one in both (i,j) and (j,i) means the two formations cannot exist in the same column.
Example for PreserveVerticalRelationship
Tertiary_Volcanic_and_Sedimentary_Rocks and Laramide_Unconformity are definitely above the basement series (Eg Chilitos_Formation_Sulphides_A). The middle formations prefixed by Chilitos (Chilitos_...) are all above the bottom two (Triassic...) but can have any vertical relationship within their series.
call %DoTask% %CaseXML% CaseControl SetLaw ^
Tertiary_Volcanic_and_Sedimentary_Rocks PreserveVerticalRelationship (0,1,1,1,1,1,1,1) ^
Laramide_Unconformity PreserveVerticalRelationship (0,0,1,1,1,1,1,1) ^
Chilitos_Formation_Sulphides_A PreserveVerticalRelationship (0,0,0,0,0,0,1,1) ^
Chilitos_Formation_Mafic_Unit_B PreserveVerticalRelationship (0,0,0,0,0,0,1,1) ^
Chilitos_Formation_Mafic_Unit_A PreserveVerticalRelationship (0,0,0,0,0,0,1,1) ^
Chilitos_Formation PreserveVerticalRelationship (0,0,0,0,0,0,1,1) ^
Triassic_Jurassic_Unconformity PreserveVerticalRelationship (0,0,0,0,0,0,0,1) ^
Zacatecas_Formation PreserveVerticalRelationship (0,0,0,0,0,0,0,0)
or SetUseTopo <0 | 1> (Also see SetAboveTopoDensityLaw CaseControl argument) (default 0)or IncludeBorderEffect <0 | 1>(default 1)or SetReferenceDensity <value> (defaults to 2.67, density contrasts are derived from this parameter)
or SetReferenceMagneticFieldMagnitude <value> (defaults to 50000)
or SetReferenceMagneticFieldInclination <value> (defaults to 0.0)
or SetReferenceMagneticFieldDeclination <value> (defaults to 0.0)
or SetReferenceLithology <ReferenceLithologyVoxetPath>
where <ReferenceLithologyVoxetPath> = path to the reference voxet with a field called Lithology
that has integers corresponding to the lithology pile. The default if this is not set is
the lithology model at the zero iteration of each separate Run.
or SetAboveTopoDensityLaw <LAW> (default Normal(2.67,0,100))
NewRun
syntax: <CaseXML> NewRun <RUN> <ARGLIST>
<RUN> = an alpha-numeric string or ‘identifier’ that will uniquely identify this run
ARGLIST=<Number Iterations>
RunControl
syntax: <CaseXML> RunControl <RUN> <ARGLIST>
ARGLIST=Seed <Seed>
or NumberOfIterations <Number Iterations>
or DefineStructuralElement
or SetHomogeneousMorphologicalFilter <StructuralElementName>
or SetDilationOrErodeMorphologicalFilter <StructuralElementName>
or LithologyInitialiseStyle <FromModel | FromVoxet <initialLithologyVoxetDesc>> (default FromModel)or DensityInitialiseStyle <FromLawRandom | FromLawMean | FromVoxet <initialDensityVoxetDesc> > (default FromLawMean)or SusceptibilityInitialiseStyle <FromLawRandom | FromLawMean | FromVoxet <initialSusceptibilityVoxetDesc> > (default FromLawMean)or RemanentMagnetisationInitialiseStyle <FromLawRandom | FromLawMean | FromVoxet <initialRemanenceVoxetDesc> > (default FromLawMean)or AllowHomogeneousFilter <0 | 1> (default 1)or HomogeneousFilterRate <rate> (defauilt 1000)or AllowDilationOrErosionFilter <0 | 1> (default 1)or DilationOrErosionFilterRate <rate> (default 5000)or ProbabilityOfPropertyChangeOnly <0-100> (default 50)or PreserveTopology <0 | 1> (default 0)or PriorOnly <0 | 1> (default 0)or AllowGeophysicalTests <1 | 0> (default 1)NB. This is identical with, and will replace, “PriorOnly <0 | 1>”.
i.e. PriorOnly 0 is equivalent to AllowGeophysicalTests 1.or SetOutputMisfits <0 | 1> (default 0)or SetOutputCommonality <0 | 1> (default 0)or AllowPropertyChangeOnFixedCell <0 | 1> (default 1)
or AllowNeighbourPropertyDifferentCheck <0 | 1> (default 1)
or SetLargeMisfitRMSThresholdFactor <value> (ignored if DualTemperatureMode set to 1)or SetLargeMisfitTemperature <value> (ignored if DualTemperatureMode set to 1)
or AllowPreserveVerticalRelationshipTest <0 | 1> (default 0)or AllowCommonalityVolumeTest <0 | 1> (default 0)or AllowCommonalityTest <0 | 1> (default 0)or SetCommonalityTestWeights <none| LocalAbundance | LocalCommonality | GlobalCommonality> (default none)or SetCommonalityVolumeTestWeights <none | LocalAbundance>(default none)or SetVolumeRatioTestWeights <none | LocalAbundance>(default none)or SetShapeRatioTestWeights <none | LocalAbundance> (default none)or AllowVolumeRatioTest <0 | 1> (default 0)or AllowShapeRatioTest <0 | 1> (default 0)or IncludeAboveTopoFacesInShapeRatio <0 | 1> (default 0)or IncludeOutsideFacesInShapeRatio <0 | 1> (default 0)or SetOutputTrendGrids <0 | 1> (NB. Written to a subdirectory of <CaseDir> call TrendGrids_<Run>) (default 1)or SetDualTemperatureMode <0 | 1> [mode1TemperatureFactor mode1Duration mode2TemperatureFactor mode2Duration] (default 0 [1, 99900, 1000000, 100])
and
the “[]” notation indicates optional arguments.
initialLithologyVoxetDesc = <initialLithologyVoxetPath> [<LithologyVoxetField>]
initialDensityVoxetDesc = <initialDensityVoxetPath> [<DensityVoxetField>]
initialSusceptibilityDesc = <initialSusceptibilityVoxetPath> [<SusceptibilityVoxetField>]
initialRemanenceDesc = <initialRemanenceVoxetPath>> [<RemanenceEastVoxetField> <RemanenceNorthVoxetField> <RemanenceDownVoxetField>]
and
initialLithologyVoxetPath=path to voxet with a field called <LithologyVoxetField> that has integers corresponding to the lithology pile. The default LithologyVoxetField is “Lithology”
initialDensityVoxetPath=path to voxet with a field called <DensityVoxetField> containing density CONTRASTS. The default DensityVoxetField is Density
initialSusceptibilityVoxetPath=path to voxet with a field called <SusceptibilityVoxetField> containing susceptibility. The default SusceptibilityVoxetField is Susceptibility
initialRemanenceVoxetPath=path to voxet with fields called <RemanenceEastVoxetField>, <RemanenceNorthVoxetField>,
<RemanenceDownVoxetField> containing the components of the remanent magnetic field.
The defaults are RemanenceEast, RemanenceNorth, and RemanenceDown respectively
Note that the order of acceptance tests is geology first and geophysics second.
Within geology tests the order is:
PreserveVerticalRelationship
Commonality
CommonalityVolume
VolumeRatio
ShapeRatio
Within geophysics tests the order is the order in which they appear in the NewCase command
SetFixedCells
syntax: <CaseXML> SetFixedCells <RUN> <ARGLIST>
ARGLIST=FORMATIONS <FORMATIONLIST>
or XYZ <XYZFILE>
or SURFACE
or OBSERVED
or CLEAR
or OBSERVED_PROVENANCE <PROVENANCE_LABEL_LIST>
or BOX <xmin> <xmax> <ymin> <ymax> <zmin> <zmax> <setInternal>
where setInternal=<0 | 1> and a value of 1 means set voxels inside or on the boundary of the box to fixed and 0 means set the points external to fixed.
If SetFixedCells is never called, the default is to set all the cells of the layer at the highest elevation to fixed. When the first call of SetFixedCells is made, this program default is cleared (i.e. equivalent to a call of SetFixedCells CLEAR) and a voxet named <Case>_<Run>_modifiable.vo is established with all values of the “Modifiable” property initialised with 1. All subsequent SetFixedCells calls are additive.
2. Running Computation
===========================
Run
syntax: <CaseXML> Run <RUN>
ForwardModelFromCase
syntax: <CaseXML> ForwardModelFromCase <OUTPUT_PREFIX>
ForwardModelFromProject
syntax: <Project> ForwardModelFromProject <eCELLSIZE> <nCELLSIZE> <zCELLSIZE> <EastMIN_VOXET> <EastMAX_VOXET> <NorthMIN_VOXET> <NorthMAX_VOXET> <ElevationMIN_VOXET> <ElevationMAX_VOXET> <MEAN_ELEVATION> <IGRF> <IncludeBorderEffect> <GEOPHYSICS_TYPE_LIST> <OUTPUT_PREFIX>
or: <Project> ForwardModelFromProject <eCELLSIZE> <nCELLSIZE> <zCELLSIZE> <EastMIN_VOXET> <EastMAX_VOXET> <NorthMIN_VOXET> <NorthMAX_VOXET> <ElevationMIN_VOXET> <ElevationMAX_VOXET> <MEAN_ELEVATION> <TEMPERATURECONTROL> Temperature <OUTPUT_PREFIX>
The easting will range from EastMIN_VOXET (the western edge of the most western voxels) to EastMIN_VOXET+NEAST*eCELLSIZE (the eastern edge of the most eastern voxels)
Where NEAST=Number of voxels in the easting direction such that
EastMIN_VOXET+(NEAST-1)*eCELLSIZE < EastMAX_VOXET and
EastMIN_VOXET+NEAST*eCELLSIZE >= EastMAX_VOXET
The northing will range from NorthMIN_VOXET (the southern edge of the most southern voxels) to NorthMIN_VOXET+NNORTH*nCELLSIZE (the northern edge of the most northern voxels)
Where NNORTH=Number of voxels in the northing direction such that
NorthMIN_VOXET +(NNORTH-1)* nCELLSIZE < NorthMAX_VOXET and
NorthMIN_VOXET + NNORTH * nCELLSIZE >= NorthMAX_VOXET
Where IGRF=<ReferenceMagneticFieldMagnitude> <ReferenceMagneticFieldInclination> <ReferenceMagneticFieldDeclination>
in units of nT,decimal degrees, decimal degrees
Where TEMPERATURECONTROL=<MeanSurfaceTemperature> <Base_Boundary_Style> <Base_Boundary_Value> <Max_Residual_Temperature>
See ForwardModelTemperatureCreateCaseFromVoxet below for details on TEMPERATURECONTROL
ForwardModelFromVoxet
syntax: ForwardModelFromVoxet <INPUT_VOXET> [<FIELDS>] <MEAN_ELEVATION> <IGRF> <IncludeBorderEffect> <ReferenceDensity> <GEOPHYSICS_TYPE_LIST> <OUTPUT_PREFIX>
where “[]” denotes optional arguments and <Fields> is a list of field names to use
Example FIELDS(Density=3MOD) uses the field 3MOD in the voxet for the Density
ForwardModelTemperatureForCreateCaseFromVoxet
syntax: <CaseXML> ForwardModelTemperatureForCreateCaseFromVoxet <ImportedVoxet> [<FIELDS>] <Mean_Surface_Temperature> <Base_Boundary_Style> <base_boundary_value> <max_residual_temperature> <max_iterations> <OUTPUT_PREFIX>
Forward calculation of temperature from a case created using CreateCaseFromVoxet on <ImportedVoxet> where “[]” denotes optional arguments and<Fields> is a list of field names to use
Example FIELDS(Density=3MOD) uses the field 3MOD in the voxet for the Density and
Mean_Surface_Temperature= is the temperature to set at the surface as a boundary condition
Base_Boundary_Style = 0 if the base boundary condition is a temperature
= 1 if the base boundary condition is a heat flow
Base_Boundary_Value = Basal boundary condition (either a temperature ( C ) or a heatflow (w/m^2) )
Max_Residual_Temperature= Convergence criteria – if the biggest temperature change during an iteration is less that this then we can stop
Max_Iterations = The maximum number of iterations to perform
OUTPUT_PREFIX = The output directory for the results of the forward computation
An alternative advanced syntax is also supported:
syntax: <CaseXML> ForwardModelTemperatureForCreateCaseFromVoxet <ImportedVoxet> [<FIELDS>] “Advanced” <Surface_Temperature_Law> <Surface_Heatflow_Law> [<Horizon_Temperature_Law>] <Base_Temperature_Law> <Base_Heatflow_Law> <max_residual_temperature> <max_iterations> <OUTPUT_PREFIX>
where
Surface_Temperature_Law = the surface temperature specified in the LAW syntax (See CastControl)
Surface_Heatflow_Law = the surface heatflow
Horizon_Temperature_Law = the temperature at an arbitrary surface specified using the XYDrape version of a LAW
Base_Temperature_Law = the basal temperature
Base_Heatflow_Law = the basal heatflow
and a value of “None” means the property is unconstrained
Note that Horizon_Temperature_Law cannot be “None” but can be omitted
3. Post Run Reporting
===========================
RunState
syntax: <CaseXML> RunState <RUN> <Iteration> <Existing Output Directory>
The output voxet will be <Existing Output Directory>\<CASE><RUN><Iteration>.vo
4. Post Run Reporting (Multi Run Interval)
===========================
MakeSummaryStats
syntax: <CaseXML> MakeSummaryStats <RunIntervalList> <Existing Output Directory>
RunIntervalList=<RunIntervalList(1)> ... <RunIntervalList(N)>
and RunInterval=<RUN> <StartIteration> <EndIteration>
MakeSuperSummaryStats
syntax: <CaseXML> MakeSuperSummaryStats <RunIntervalList> <Threshold> <Existing Output Directory>
RunIntervalList=<RunIntervalList(1)> ... <RunIntervalList(N)>
and RunInterval=<RUN> <StartIteration> <EndIteration>
<Threshold> is the percentage value to use for the MostProbableThresholded output where only those voxels for which the MostProbable formation had a probability greater than <Threshold> are retained
MakeEvolutionMovie
syntax: <CaseXML> MakeEvolutionMovie <RunIntervalList> <MovieControl> <incrIteration> <ColourStyle> <ScaleOption> <EvolutionField> <Section> <Existing Output Directory>
MovieControl=<MaxCols> <MaxRows> <VerticalExaggeration> <FramesPerSecond> <QualityPercentage>
ScaleOption=<LogOrLinear> <minClip> <maxClip>
Where
LogOrLinear=0 for Linear and 1 for Log
MinClip=minimum value or use minClip=Auto to have the software automatically calculate this
MaxClip=maximum value or use maxClip=Auto to have the software automatically calculate this
EvolutionField=<Lithology | Density | Susceptibility | RemanenceEast | RemanenceNorth | RemanenceDown>
ColourStyle = <LithologyColours | Colours | Greyscale>
AboveTopo cells are shown in red if the ColourStyle is Greyscale and in black if the ColourStyle is LithologyColours or Colours.
5. Run Reporting (Multi Voxet)
===========================
MakeHistogram
syntax: <CaseXML> MakeHistogram <InputVoxet> <InputLithologyField> <InputPropertyField> <NumberOfBins> <ScaleOption> <Output Report>
Information on the requested property distributions is read from the definitions in the specified Case.
6. Reporting (DerivedVoxet processing)
===========================
MakeSectionImage
syntax: <CaseXML> MakeSectionImage GetField(<DerivedVoxet>,<FieldWithinDerivedVoxet>) <Section> <MaxCols> <MaxRows> <VerticalExaggeration> <QualityPercentage> <ColourStyle> <ScaleOption> <OUTPUT_PREFIX>
GetField(<DerivedVoxet>,<FieldWithinDerivedVoxet>) extracts data for a specified Field from a specified Voxet. There must be no spaces within the braces.
<DerivedVoxet> is any voxet which is derived from the GeoModeller Project
<FieldWithinDerivedVoxet>) is a Keyword as used in the voxet header file such as Lithology, MostProbable, MostProbableThresholded, MeanDensity, StdDevDensity, Probablity0, Probablity1, etc.
<Section> is the name of an existing Section in the GeoModeller Project
MakeAllSectionImages
syntax: <CaseXML> MakeAllSectionImages GetField(<DerivedVoxet>,<FieldWithinDerivedVoxet>) <MaxCols> <MaxRows> <VerticalExaggeration> <QualityPercentage> <ColourStyle> <ScaleOption> <OUTPUT_PREFIX>
Runs MakeSectionImage for all Sections in the project
GetField(<DerivedVoxet>,<FieldWithinDerivedVoxet>) extracts data for a specified Field from a specified Voxet. There must be no spaces within the braces.
<DerivedVoxet> is any voxet which is derived from the GeoModeller Project
<FieldWithinDerivedVoxet>) is a Keyword as used in the voxet header file such as Lithology, MostProbable, MostProbableThresholded, MeanDensity, StdDevDensity, Probablity0, Probablity1, etc.
MakeDerivedVoxet
syntax: <CaseXML> MakeDerivedVoxet <RUN> <DerivedVoxet> <Output Voxet>
MakeSectionMovie
syntax: <CaseXML> MakeSectionMovie <SweepLineCoordinates> <MovieControl> <NoFramesAlongSweep> <MAX_SECTION_WIDTH> <DerivedVoxet> <ColourStyle> <ScaleOption> <Output AVI>
LINE_COORDS = <EastingForCentreLineStart> <NorthingForCentreLineStart> <EastingForCentreLineEnd> <NorthingForCentreLineEnd>
MAX_SECTION_WIDTH = the maximum horizontal length of section, limited by the extent of the project/inversion model
Sections entirely outside the project extent are omitted from the movie.
7. Utilities (voxetutil.exe)
===========================
All commands are prefaced by the name of the executable, voxetutil. The parent directory of the licensed GeoModeller
Installation must be on the path as well as the client subdirectory (For 32bit Windows) and the server subdirectory (For 64bit Windows)
MakeSurfaceShells (From Single Voxet)
syntax: MakeSurfaceShells <Input Voxet> <Input Field> <OPERATOR> <ISO VALUE> <OUTPUT_PREFIX>
OPERATOR is one of EQ, LE, or GE)
MakeMovie (From a list of JPG image files)
syntax: MakeMovie <FramesPerSecond> <MaxCols> <MaxRows> <Input jpg List> <Output MPG>
DumpVoxet (From Single Voxet)
syntax: DumpVoxet <Input Voxet> <Output CSV>
CreateDepthFunction
syntax: <CaseXML> CreateDepthFunction F(d1,v1,…,di,v2i,…) <Output Voxet> <Output Field>
Where (di,vi) are the points of a spline used to calculate the value of the function at depth. The di represents the depth of the ith point and vi represents the value (eg. Density) at the ith point. The depth is measured relative to the topographic surface.
Horizons
syntax: Horizons <Input SuperSummaryStatsVoxet> <OutputVoxet> <Threshold>
Where OutputVoxet will contain for each formation the probability that any given cell is the top of that formation.
Treating each column in the OutputVoxet as a probability distribution for each formation a csv file is created that gives the upper and lower depths for the nominated <Threshold> (defaults to 90).
That is, the depths for which the cumulative probability is (100-<Threshold>)/2 and (100-((100-<Threshold>)/2).
The names of the csv files will be of the form Prob_<Formation>_bounds.csv
StatsVoxet
syntax: StatsVoxet <Input Directory containing Voxets of the same size> <OutputStatsVoxet>
Threshold
syntax: Threshold <InputStatsVoxet> <InputFieldName> <ThresholdValue> <ConfidenceBounds> <OutputVoxet>
Where <InputStatsVoxet> is an <OutputVoxet> from the StatsVoxet process.
And where <OutputVoxet> will contain the value <ThresholdValue> if the value at a cell is within the <ConfidenceBounds> of the <ThesholdValue>. For cells below the <ThresholdValue> and outside the confidence bound the value will be zero. For cells above the <ThresholdValue> and outside the confidence bound the value will be 2 times the <ThresholdValue>.
ConfidenceBounds = a positive number denoting the number of standard deviations of the confidence bounds
or
ConfidenceBounds = <ConfidencePercentage>%
where
<ConfidencePercentage> = a positive number denoting the confidence bounds as a percentage.
8. Extra syntax definitions
===========================================
DerivedVoxet = MostProbableField(<SummaryStats Voxet Prefix>,<Field>,<Threshold>)
which means: Create a voxet where each cell is assigned as follows:
1. Look at the set of voxets beginning with the string with <SummaryStats Voxet Prefix>
2. Pick the one with the highest probability >= Threshold
3. Lookup the value of <Field> for that voxet at that cell
4. This becomes the value of the new voxet at that cell
or WeightedField(<SummaryStats Voxet Prefix>,<Field>)
which means: Create a voxet where each cell is assigned as follows:
1. Look at the set of voxets beginning with the string with <SummaryStats Voxet Prefix>
2. Calculate a weighted average of <Field> based on the probablity
3. This becomes the value of the new voxet at that cell
or MostProbableLithology(<SummaryStats Voxet>,<Threshold>)
which means: Create a voxet where each cell is assigned as follows:
1. Look at the set of voxets beginning with the string with <SummaryStats Voxet Prefix>
2. Pick the one with the highest probability >= Threshold
3. The lithology index of this picked one becomes the value of the new voxet at that cell
or GetField(<Input Voxet>,<Field>)
which means: Create a voxet where each cell is assigned as follows:
1. Retrieve the value of <Field> for the <Input Voxet> at that cell
2. This becomes the value of the new voxet at that cell
Threshold = Threshold probability as a percentage
Document formatting notes: The document uses the following styles – Plain text, Command, Syntax, Command_comment, Command_example.