Environments | PYTHON :: EASI :: MODELER |
Quick links | Description :: Parameters :: Parameter descriptions :: Details :: Example :: Related |
Back to top |
Back to top |
Name | Type | Caption | Length | Value range |
---|---|---|---|---|
MFILE* | String | Name of input file, folder, or text file | 1 - 192 | |
DBIC | Integer | Input raster channels | 0 - | |
MMSEG | Integer | Input math-model segment | 0 - 1 | |
DBIW | Integer | Raster input window | 0 - 4 | XOff, YOff, XSize, YSize |
SRCBGD | String | Source background value | 0 - 192 | Default: FILE |
FILO | String | Name of output file or folder | 0 - 192 | |
FTYPE | String | Format of output file | 0 - 4 | PIX | TIF Default: PIX |
FOPTIONS | String | Options for output format | 0 - 64 | |
OUTBGD | Float | Output background value | 0 - 1 | Default: 0 |
ULX | String | Upper-left x-coordinate of output image | 0 - 32 | |
ULY | String | Upper-left y-coordinate of output image | 0 - 32 | |
LRX | String | Lower-right x-coordinate of output image | 0 - 32 | |
LRY | String | Lower-right y-coordinate of output image | 0 - 32 | |
EDGECLIP | Integer | Clip edges automatically | 0 - 2 | -49 - 49 Default: 0 |
TIPOSTRN | String | Transformation of tile positioning | 0 - 192 | |
MAPUNITS | String | Output projection units | 0 - 192 | |
BXPXSZ | String | Size of output horizontal pixel | 0 - 32 | |
BYPXSZ | String | Size of output vertical pixel | 0 - 32 | |
FILEDEM | String | File or folder containing the digital elevation model | 0 - 192 | |
DBEC | Integer | Input elevation channel | 0 - 1 | |
BACKELEV | Float | Background elevation value | 0 - 1 | |
ELEVREF | String | Vertical reference for elevation values | 0 - 192 | |
ELEVUNIT | String | Elevation value units | 0 - 7 | METER | FEET | US_FEET |
ELFACTOR | Float | Elevation offset and scale | 0 - 2 | |
PROC | String | Processing algorithm | 0 - 192 | |
SAMPLING | Integer | Sampling interval | 0 - 1 | 1 - Default: 1 |
RESAMPLE | String | Resampling method | 0 - 192 | NEAR|BILIN|CUBIC|SINC8|SINC16|AVERAGE|MEDIAN|GAUSSIAN|CPLXSAR Default: CUBIC |
Back to top |
MFILE
The name of an image file, a folder, or a text file that contains the input images to process.
For information about basic use of an MFILE with CATALYST Professional algorithms, see Using an MFILE with a CATALYST Professional algorithm.
When you specify multiple files for MFILE, by using a text-file list or a wildcard, ORTHO prefixes the output files with the letter o to indicate that they are orthorectified. The files are created in the folder you specify for FILO.
With file channels, you can specify them individually or as a sequence. An individual channel index is a single, positive integer, such as "1"). A channel sequence is a positive integer followed by a comma and a negative number, such as "1,-3". That is, specifying "1,-3" will process inclusively channels 1 through 3; internally, the negative value is expanded to "1,2,3". The second channel number in the sequence must be greater than the first.
For more information about specific use of an MFILE file with the MFILE parameter in ORTHO; namely, the format thereof, see Format of input text file with MFILE.
DBIC
The channel or channels in the input file to process.
Each channel you specify must be of the same data type. If you do not specify a value for this parameter, ORTHO processes all channels in the source file.
Ranges of channels or segments can be specified with negative values. For example, {1,-4,10} is internally expanded to {1,2,3,4,10}. When you are not specifying a range in this way, only 48 numbers can be specified explicitly.
MMSEG
The math-model segment of the input raw image to use in orthorectification. All math-model types are supported.
If you do not specify a value for this parameter, the last model segment in the input file is used.
DBIW
The raster window of data to read from the input channels. The window is determined by the x-offset, y-offset, x-size, and y-size.
X-offset and y-offset define the pixel coordinate at the upper-left corner of the window. X-size is the number of pixels that define the width of the window. Y-size is the number of lines that define the height of the window.
If you do not specify a valued for this parameter, ORTHO processes the entire image.
SRCBGD
The pixels in the source image to consider as background (NoData) pixels. Typically, ORTHO processes NoData pixels in a specific manner.
FILE: Reads the NoData value from the metadata of the input file. If the file-level NO_DATA_VALUE metadata tag is found in the source raster, its value is used as the default for all channels in the file. ORTHO then searches for channel-level NoData tags. If a channel-level NoData tag is found, it overrides the file-level value for that channel.
If there are channel-level NoData tags, but no file-level tag, a pixel is processed as NoData when each of the channels with a NoData tag corresponds to its NoData value. In this case, channels without a NoData tag are ignored when identifying background pixels.
If NoData tags are not found in the file, a default of ALL,0 is used. To use a rule other than the default when NoData tags are not found, include it after a comma. For example, to use the NoData tags of the file, if found, enter "FILE,ANY,3"; otherwise, the rule used for the source background is "ANY,3".
FILE is the default value for this parameter.
With ALL and ANY, the background pixel is described by the "background rule" and a list of one or more pixel values for the different image channels. The "background rule" must be entered as ALL or ANY. ALL indicates that the pixel value in each channel must match the background value entered to consider the pixel as background. ANY indicates that if any channel equals the background value, consider the pixel as background.
You can enter the background value as either a single number (applied to all channels) or as a pixel "stack". If you enter a pixel stack, but the number of values does not equal the number of channels, the list will be truncated, or the last value will be repeated, as necessary. The background values you enter are truncated to the range allowed by the data type of the source image.
FILO
FTYPE
The format of the output file. The format must be of a GDB-supported type.
The default is PCIDSK (.pix).
FOPTIONS
The options specific to the format to apply when creating the output file. With each, the default of no options is allowed (empty string).
Typically, the available options for a format include a compression scheme, format subtype, or other information.
OUTBGD
The background (NoData) value to use for orthorectified pixels that are not populated. Each channel is set to the same background value. The value will be truncated to the range allowed by the data type of the source image.
ULX
The upper-left-ground x-coordinate, in map units, for the output orthorectified image based on the value of MAPUNITS.
If you do not specify a value for this parameter, ORTHO calculates and uses the coordinate of the upper-left corner for the maximum extent of the orthorectified image.
When you specify a text file for MFILE, and the file contains an upper-left-corner x-coordinate, it will override the value of this parameter.
ULY
The upper-left-ground y-coordinate, in map units, for the output orthorectified image based on the value of MAPUNITS.
If you do not specify a value for this parameter, ORTHO calculates and uses the coordinate of the upper-left corner for the maximum extent of the orthorectified image.
When you specify a text file for MFILE, and the file contains an upper-left-corner y-coordinate, it will override the value of this parameter.
LRX
The lower-right-ground x-coordinate, in map units, for the output orthorectified image based on the value of MAPUNITS.
If you do not specify a value for this parameter, ORTHO calculates and uses the coordinate of the lower-right corner for the maximum extent of the orthorectified image.
When you specify a text file for MFILE, and the file contains an upper-left-corner x-coordinate, it will override the value of this parameter.
Typically, the lower-right-corner coordinate of the orthorectified image will not have this exact value, because it must conform to the upper-left coordinate and pixel size; however, the generated image will be large enough so that the lower-right x-coordinate is within the raster extents.
LRY
The lower-right-ground y-coordinate, in map units, for the output orthorectified image based on the value of MAPUNITS.
If you do not specify a value for this parameter, ORTHO calculates and uses the coordinate of the lower-right corner for the maximum extent of the orthorectified image.
When you specify a text file for MFILE, and the file contains an upper-left-corner x-coordinate, it will override the value of this parameter.
Typically, the lower-right-corner coordinate of the orthorectified image will not have this exact value, because it must conform to the upper-left coordinate and pixel size; however, the generated image will be large enough so that the lower-right y-coordinate is within the raster extents.
EDGECLIP
The percentage of the image to clip from the edges during orthorectification. Clipping applies to each edge of the image.
For example, to clip five percent from the leftmost edge and 5 percent from the right, enter 5.
The edge clipping value can either be positve (clipping from raw image) or negative (clipping from orthorectified image). The maximum and minimum values are +/-49.
If the value is negative, edge clipping occurs after the extents of the orthorectified image (ULX, ULY, LRX, LRY) are determined, but before applying tile-positioning transformation.
TIPOSTRN
An adjustment of the upper-left-corner coordinate for the orthorectified image.
By specifying an adjustment you can generate orthorectified images that fall on a specific raster grid. You do so by providing a keyword and either two or four values.
The values define the position of the corner or center in relation to the raster grid.
Of the four values, only Stride_X is required. If not specified, Stride_Y defaults to the value of Stride_X, and Ref_X, Ref_Y default to zero.
Depending on the distance of the tile from that point, its upper-left x-coordinate can be 432345.000, 432365.000, or any other multiple, but never 432346.000 or 432355.000.
If you specify values for this parameter, the effect applies in all scenarios, regardless of whether the image-corner coordinates come from the input file, upper-left x or y coordinate, or as a result of automatic computation.
This parameter is optional.
MAPUNITS
The projection string for the output orthorectified image. If you do not specify a projection, the map units are determined automatically.
When you specify METER or FEET, the math model and digital elevation model (DEM) also must be METER or FEET.
When you specify a regular, Earth-referenced projection, the math model and DEM also must use a regular projection (not necessarily the same one); that is, METER and FEET are not allowed.
LCC D350 | 0 0 3.0 46.5 44.0 49.0 700000 6600000 0 0 0 0 0 0 0 0 0 -1
You can specify the UTM grid-zone number and row, and the Earth model, as follows:
UTM [mm] [r] [Ennn]
Where:
You can specify the Earth model for LONG/LAT (and other units except METER or FEET), as follows:
LONG/LAT [Ennn]
You can specify the SPCS-zone number and Earth model, as follows:
SPCS [mmmm] [Ennn]
If the Earth model is not specified, it is assumed to be E000 (Clarke 1866).
If you do not specify a value for MAPUNITS, the logic for determining a default ortho-coordinate system is as follows:
BXPXSZ
The size of the horizontal pixel of the output image.
The output pixel size is expressed in the same units as the coordinate system of the orthorectified image.
If you do not specify a value for this parameter, a default pixel size is computed automatically.
This parameter is optional.
BYPXSZ
The size of the vertical pixel of the output image.
The output pixel size is expressed in the same units as the coordinate system of the orthorectified image.
If you do not specify a value for this parameter, the specified horizontal pixel size is used. If you specify neither a horizontal nor a vertical pixel size, the pixel size is computed automatically.
This parameter is optional.
FILEDEM
The name of a file, folder, or DEM index file containing DEM tiles.
The following table describes the processing of FILEDEM based on the value you specify.
Value | Processing |
---|---|
Name of a single, raster-DEM file | The values of DBEC, BACKELEV, ELEVREF, ELEVUNIT and ELFACTOR are used, if specified. |
Name of an existing folder | ORTHO reads the folder for a index.txt file. The file must be in the DEM-index format, as described in DEM index file. |
Name of a text file | The file must have a .txt file name extension and be in the DEM-index format, as described in DEM index file. |
If you do not specify a value, the offset component of ELFACTOR and ELEVREF are used to define the height surface for orthorectification.
This parameter is optional.
DBEC
The channel number of the input digital elevation model (DEM) elevation channel to process.
This parameter is ignored if the value of FILEDEM is an empty string or a DEM-index text file.
If the value of FILEDEM is a single file, and you do not specify a value for DBEC, a channel is selected as the most likely DEM channel by using the following logic:
BACKELEV
The background elevation (NoData) value in the input elevation channel.
If you do not specify a value for this parameter, ORTHO searches for ELEVATION_BACKGROUND or NO_DATA_VALUE metadata tags, first at the channel level, then at the file level. If this value is neither specified nor found in the metadata, a default value of -32768 is applied.
If the value of FILEDEM is an empty string or a DEM-index text file, this parameter is ignored.
This parameter is optional.
ELEVREF
The vertical reference for the elevation values in the source DEM, or for the constant value of ELFACTOR, if defined.
If the value of FILEDEM is an empty string or a DEM-index text file, this parameter is ignored.
If you do not specify a value for this parameter, the value of the ELEVATION_DATUM metadata tag is used. If the tag does not exist in the DEM, the default value is used.
This parameter is optional.
ELEVUNIT
The units of the elevation values that are stored as pixel values in the input DEM, as specified either by the value of InputDEM: Input elevation channel or by the first value specified for Elevation scale and offset.
The units of the elevation values that are stored as pixel values in the input DEM, as specified either by the value of FILEDEM or by the first value specified for ELFACTOR.
If you specify the elevation values as FEET, the conversion factor to meters is 0.3048 (corresponding to International Feet); if you specify US_FEET, the conversion factor is 1200/3937 (corresponding to U.S. Survey Feet).
If the value of FILEDEM is an empty string or a DEM-index text file, this parameter is ignored.
If you do not specify a value for this parameter, the value of the ELEVATION_UNITS metadata tag is used. If the tag does not exist in the DEM, the default value is used.
ELFACTOR
The values or values by which to shift and scale the DEM pixel values according to the unit of measure specified for ELEVUNIT.
You can enter enter up to two values to specify this parameter: the first defines the offset while the second, optionally, defines the scale.
The conversion formula is as follows:
elevation_value = scale \u00c3\u2014 (DEM_pixel_value + offset)
If you do not specify a value for FILEDEM, only the offset value of ELFACTOR is significant. That is, the value is interpreted as a uniform elevation value in the units specified by ELEVUNIT and by using the vertical reference specified by ELEVREF.
If the value of FILEDEM is an empty string or a DEM-index text file, this parameter is ignored.
If you do not specify a value for this parameter, a default of 0.0 and and 1.0 is applied for offset and scale, respectively.
If you do not specify a value for this parameter, the values of the ELEVATION_OFFSET and ELEVATION_SCALE metadata tags are used. If the tag does not exist in the DEM, the default value is used.
PROC
The amount of memory (in megabytes) for the algorithm to use.
If you do not specify a limit for the host memory, a default of 1 GB or half the available physical memory, whichever is smaller, is applied.
SAMPLING
The pixel spacing at which rigorous calculations are performed; that is, the spacing at which the math model is evaluated to determine the location of the orthorectified pixel in the source raster. A value of 1 causes the rigorous calculation to be performed for each output pixel.
With intermediate pixels, the projection from the image to the Earth surface is approximated by linearly interpolating it from the nearest locations at which the full orthorectification operation was performed.
Entering a value of 1 will provide satisfactory results in most cases. However, with math models that are more computationally intensive, a greater value may improve performance, but at the expense of accuracy. The degree of loss in accuracy will depend on viewing geometry, and the resolution and roughness of the DEM.
RESAMPLE
The resampling method to use for orthorectification.
SINC8,SHAPINGWINDOW=[sw],BETA=[beta]: Eight-point sin(x)/x.
SINC16,SHAPINGWINDOW=[sw],BETA=[beta]: 16-point sin(x)/x
CPLXSAR,NUMCOLS=[nc],NUMROWS=[nr],FC=[fc]: Complex SAR resampler for use only with complex data.
GAUSSIAN,DSFACTORCOL=[dc],DSFACTORROW=[dr]: Gaussian resampler.
With each resampling method, the parameters MIN=[min], MAX=[max], and FILL=[NN or BGD] can be appended as a comma-delimited list. MIN and MAX define the clamp range for output pixels. This is useful when you want to keep pixel values within a certain range; for example, 1 to 2,047 if 11-bit data is stored in a 16-bit file. FILL defines the behavior when the resampling window contains NoData pixels: NN performs resampling by using the nearest-neighbor method, while BGD indicates that the output pixel will be set to the background value. By default, NN is used for FILL.
For more information about the available resampling methods, see Resampling.
Back to top |
ORTHO performs orthorectification or geometric correction on raw image data when a math model exists. If a DEM is specified as input, orthorectification also corrects for relief displacement. ORTHO supports geometric correction using PCI-supported math models.
Format of input text file with MFILE
If the value of MFILE is a text file, the files and parameters listed in the file must be delimited by semicolons and must appear in the following order
[FILE] ; [DBIC] ; [MMSEG] ; [ULX] ; [ULY] ; [LRX] ; [LRY]
Only the [FILE] entry is mandatory; all other entries are optional.
For example, the following MFILE text file line:
/data/modeled/2051.pix; 1,-4,6,7; ;559741; 4282182; 560741; 4281182
Ranges of channels can be specified by using negative values; for example, {1,-4} is expanded internally to {1,2,3,4}.
The value of MFILE can be the name of a file, a folder, or a text file. When you specify a file, it must be formatted as described herein; that is, it must match the DEM-index format. When you specify a folder, ORTHO searches the folder for an index.txt file. The file must also match the DEM-index format.
The format of a DEM-index file allows it to be processed like a single, virtual DEM, which eliminates having to merge the DEM tiles into a single file.
The following text shows an example of a DEM index file.
MAPUNITS LONG/LAT D000 DATATYPE 16S DBEC 1 BACKELEV -32768.000 ELEVREF MSL ELEVUNIT METER ELFACTOR 0.000 1.000000000000 RES_XY 0.0008333333333333 0.0008333333333333 #Filename ULX ULY LRX LRY srtm_01_02.tif -180.000416666676760 55.000416618227803 -174.999583333343420 49.999583284894470 srtm_01_07.tif -180.000416690891140 30.000417247801863 -174.999583357557810 24.999583914468531 srtm_01_12.tif -180.000416690891140 5.000416642442191 -174.999583357557810 -0.000416690891143 srtm_01_15.tif -180.000416666676760 -9.999582994342006 -174.999583333343420 -15.000416327675339 srtm_01_16.tif -180.000416666676760 -14.999583115413941 -174.999583333343420 -20.000416448747274 srtm_01_17.tif -180.000416666676760 -19.999583236485876 -174.999583333343420 -25.000416569819208 srtm_01_18.tif -180.000416666676760 -24.999583357557810 -174.999583333343420 -30.000416690891143
The first eight lines of the file describe common values that apply to each image; they must be in the order shown in the example with no comments or blank lines between them. The remaining lines describe the image boundary records for each image in the DEM tile data set. Comments (lines beginning with a #) are allowed in the list of DEM tiles in the file.
DATATYPE: The data type of the files.
DBEC: The channel number for the input digital elevation model (DEM) elevation channel to be processed.
BACKELEV: The background elevation (NoData) value in the input DEM elevation layer.
ELEVREF: The vertical reference for the elevation values contained in the source DEM, or for the constant ELFACTOR value, if it is used.
ELEVUNIT: The units of the elevation values that are stored as pixel values in the input DEM, as specified either by FILEDEM or by the first entry in ELFACTOR.
ELFACTOR: When an input digital elevation model (FILEDEM) is specified, the value of this parameter is used to shift and scale the DEM pixel values to values in the units indicated by the value of the ELEVUNIT parameter.
RES_XY: The x and y image-resolution values.
As individual raster tiles are accessed, their properties are compared with the values listed in the DEM index file. If they do not conform to the indicated values, an error message appears in the log.
Conversion of DEM height
Calculation of orthorectification layout
Consider the x, y, and z position of each boundary pixel in the DEM, determine the positions in the source image, and then discard any pixels that do not fall within the extents of the source image.
The set of boundary pixels in the orthorectified image is defined as all the image-boundary pixels falling within the DEM raster and all of the DEM-boundary pixels falling within the source-image raster.
Input of degrees, minutes, and seconds
Each field that accepts string-encoded, numeric parameters can accept an input format of degrees, minutes, and seconds (DMS). ORTHO automatically converts the specified value to a decimal number. This conversion is performed even if the coordinate system of the orthorectified image is not LAT/LONG; the converted decimal number is assumed to be in the units of the coordinate system of the orthorectified image.
Back to top |
In this example, an airphoto is used for orthorectification, using the DEM in the file dem.pix. The DEM is referenced to mean sea level (MSL), and it has a NoData value of 0.0. The output orthorectified image will have a different channel order than the input scene, and a 512-pixel boundary will be trimmed from all edges of the source image. The upper-left corner will be adjusted such that it is an even multiple of 3.36 (8 x <output resolution>) to aid in alignment with other data sets.
EASI>mfile="rawAirphoto.pix" EASI>dbic=3,2,1 EASI>mmseg= EASI>dbiw=512,512,10286,16286 EASI>srcbgd = "NONE" EASI>filo = "oAirphoto_trim512_ch321_EASI.pix" EASI>ftype = "PIX" EASI>foptions = "TILED256" EASI>outbgd=0 EASI>ulx = "" EASI>uly = "" EASI>lrx = "" EASI>lry = "" EASI>edgeclip=0 EASI>tipostrn = "CORNER,3.36,3.36" EASI>mapunits = "" EASI>bxpxsz = "0.42" EASI>bypxsz = "" EASI>filedem = "dem.pix" EASI>dbec=1 EASI>backelev=0.0 EASI>elevref = "MSL" EASI>elevunit = "METER" EASI>elfactor=0.0,1.0 EASI>proc = "600" EASI>sampling=1 EASI>resample = "CUBIC" EASI>r ortho
© PCI Geomatics Enterprises, Inc.®, 2024. All rights reserved.