User's Guide

EDITDDR

Edits the contents of the input DDR file.

Function:

Edits the contents of the input DDR file or creates a new DDR file.

Parameters:

Subcommand -SCREEN:
Screen mode of EDITDDR. In this mode the values of the DDR are displayed on the screen and the user may interactively edit any of the fields.


NOTE:  This subcommand cannot be used for BATCH 
       processing. 

IN
Input image. The name of the image that the DDR file describes and is associated with. The image may or may not already exist, but the DDR file has to exist.
Subcommand -TUTOR:
Tutor mode of EDITDDR. In this mode the user can enter values for any of the fields of the DDR that the user wishes to change.


--If the DDR already exists and a value of NULL is 
  entered for any parameter, the corresponding DDR 
  field remains unchanged. 

--If the DDR file does not exist--NL, NS, NBANDS,
  and ODTYPE are then required parameters.  If a value
  of NULL is entered for any of the other parameters,
  the corresponding DDR field is given a value of
  zero or a blank with the following exceptions.

  1.  The validity flags are set according to the TAE 
      global $DDRVFLG.  (See LASGBLS.)
  2.  The system field is updated. 
  3.  The last modified date and time fields are updated.

NOTE:  Use this subcommand for BATCH processing.

IN
Input image. The name of the image that the DDR file describes and is associated with. The image and DDR file may or may not already exist.

NL(--)
Number of lines. The number of lines in the image. This parameter is required when the DDR file does not exist.

NS(--)
Number of samples. The number of samples per line in the image. This parameter is required when the DDR file does not exist.

NBANDS(--)
Number of bands. The number of bands in the image. This parameter is required when the DDR file does not exist.

ODTYPE(--)
Output data type. The data type of the image. This parameter is required when the DDR file does not exist.


  = BYTE: BYTE       (8-bit unsigned integer)  
                     (0 through 255)
  = I*2:  INTEGER*2  (16-bit signed integer)
		     (-32768 through 32767)
  = I*4:  INTEGER*4  (32-bit signed integer)
		     (-2147483648 through 2147483648)
  = R*4:  REAL*4     (32-bit signed real)
		     (System dependent)

MLINE(--)
Master line. Line number relative to the master image.

MSAMP(--)
Master sample. Sample number relative to the master image.

PROJTYPE(--)
Projection type. Refer to the Geometric Manipulation Package Overview Document (GEOMPOD) for further details. The user may enter either the projection key word or the projection number. Valid projection system types are:


  = GEO(0):	  Geographic   
  = UTM(1):	  Universal Transverse Mercator
  = SPCS(2):	  State Plane Coordinate System
  = ALBERS(3):	  Albers Conical Equal Area
  = LAMCC(4):	  Lambert Conformal Conic
  = MERCAT(5):	  Mercator
  = PS(6):	  Polar Stereographic
  = POLYC(7):	  Polyconic
  = EQUIDC(8):	  Equidistant Conic
  = TM(9):	  Transverse Mercator
  = STEREO(10):	  Stereographic
  = LAMAZ(11):	  Lambert Azimuthal Equal-Area
  = AZMEQD(12):	  Azimuthal Equidistant
  = GNOMON(13):	  Gnomonic
  = ORTHO(14):	  Orthographic
  = GVNSP(15):	  General Vertical Near-Side Perspective
  = SNSOID(16):	  Sinusoidal
  = EQRECT(17):	  Equirectangular
  = MILLER(18):	  Miller Cylindrical
  = VGRINT(19):	  Van der Grinten
  = HOM(20):	  Hotine Oblique Mercator
  = ROBIN(21):	  Robinson
  = SOM(22):	  Space Oblique Mercator
  = ALASKA(23):   Alaska Conformal
  = GOOD(24):     Interrupted Goode Homolosine.
  = MOLL(25):     Mollweide
  = IMOLL(26):    Interrupted Mollweide
  = HAMMER(27):	  Hammer
  = WAGIV(28):    Wagner IV
  = WAGVII(29):   Wagner VII
  = OBEQA(30):    Oblated Equal Area
  = USERDEF(XX):  User defined

PTVAL(--)
Projection type validity. The validity of the projection type value.


  = IN:   Invalid.  The value is known to be invalid.
  = VAL:  Valid.  The value is known to be valid.
  = UN:   Unknown.  The validity of the value is not
          known.

ZONENUM(--)
Zone number. The zone to use for UTM and State Plane projection systems. Refer to the Geometric Manipulation Package Overview Document (GEOMPOD) for further details.

ZNVAL(--)
Zone number validity. The validity of the zone code value.


  = IN:   Invalid.  The value is known to be invalid.
  = VAL:  Valid.  The value is known to be valid.
  = UN:   Unknown.  The validity of the value is not 
          known.

DCODE(--)
Datum code. The datum can be used for setting the semimajor axis and eccentricity squared for a particular projection. Refer to the Geometric Manipulation Package Overview Document (GEOMPOD) for further details. The supported datums are:


  0 = Clarke 1866 
  1 = Clarke 1880
  2 = Bessel
  3 = International 1967
  4 = International 1909
  5 = WGS 72
  6 = Everest
  7 = WGS 66
  8 = GRS 1980
  9 = Airy
 10 = Modified Everest
 11 = Modified Airy
 12 = Walbeck
 13 = Southeast Asia
 14 = Australian National
 15 = Krassovsky
 16 = Hough
 17 = Mercury 1960
 18 = Modified Mercury 1968
 19 = Sphere of radius (6370997 meters)

DCVAL(--)
Datum code validity. The validity of the datum code value.


  = IN:   Invalid.  The value is known to be invalid.
  = VAL:  Valid.  The value is known to be valid.
  = UN:   Unknown.  The validity of the value is not 
          known.

PROJPARM(--)
Projection parameters. These parameters are required to define each map projection. Refer to the Geometric Manipulation Package Overview Document (GEOMPOD) for further details.

PPVAL(--)
Projection parameters validity. The validity of the projection parameter values.


  = IN:   Invalid.  The value is known to be invalid.
  = VAL:  Valid.  The value is known to be valid.
  = UN:   Unknown.  The validity of the value is not 
          known.

UPLEFT(--)
Upper-left corner coordinates. The location of the upper-left corner. The coordinates are entered in latitude/longitude or northing/easting order.

LOLEFT(--)
Lower-left corner coordinates. The location of the lower-left corner. The coordinates are entered in latitude/longitude or northing/easting order.

UPRIGHT(--)
Upper-right corner coordinates. The location of the upper-right corner. The coordinates are entered in latitude/longitude or northing/easting order.

LORIGHT(--)
Lower-right corner coordinates. The location of the lower-right corner. The coordinates are entered in latitude/longitude or northing/easting order.

CCVAL(--)
Corner coordinates validity. The validity of the corner coordinate values.


  = IN:   Invalid.  The value is known to be invalid.
  = VAL:  Valid.  The value is known to be valid.
  = UN:   Unknown.  The validity of the value is not 
          known.

PDLINE(--)
Projection distance in line direction. The distance on the ground (in the line direction) that one line represents in projection units.

PDSAMP(--)
Projection distance in sample direction. The distance on the ground (in the sample direction) that one sample represents in projection units.

PDVAL(--)
Projection distance validity. The validity of projection distance in the line and sample directions.


  = IN:   Invalid.  The value is known to be invalid.
  = VAL:  Valid.  The value is known to be valid.
  = UN:   Unknown.  The validity of the value is not 
          known.

PUNITS(--)
Projection measurement units. The measurement system used for the projection dimensions. The current standard projection units include the following (all others are user-defined):


  radians
  degrees
  seconds
  dms
  feet
  meters

PUVAL(--)
Projection units validity. The validity of the projection measurement units.


  = IN:   Invalid.  The value is known to be invalid.
  = VAL:  Valid.  The value is known to be valid.
  = UN:   Unknown.  The validity of the value is not 
          known.

LINEINC(--)
Line increment. The line increment factor used for the subsampling or expansion of the image. A positive value greater than one represents that the image has been subsampled. A value between zero and one represents that the image has been expanded. A value of zero or one means that the image has not been subsampled or expanded.

SAMPINC(--)
Sample increment. The sample increment factor used for the subsampling or expansion of the image. A positive value greater than one represents that the image has been subsampled. A value between zero and one represents that the image has been expanded. A value of zero or one means that the image has not been subsampled or expanded.

INCVAL(--)
Increment validity. The validity of the line and sample increment values.


  = IN:   Invalid.  The value is known to be invalid.
  = VAL:  Valid.  The value is known to be valid.
  = UN:   Unknown.  The validity of the value is not 
          known.

LMDATE(--)
Last modified date. This is the date that the image was last modified. The date should be entered using the "dd-mmm-yy" format.


Example:  

December 31, 1986 should be entered as 31-dec-86 
         (with month in lower case)

LMTIME(--)
Last modified time. This is the time that the image was last modified. The time should be entered using a twenty-four hour clock; seconds are separated by a colon.


Example:  

1:05:55 p.m. should be entered as 1305:55

SYSTEM(--)
System. This is the system whose data format the image adheres to.

BANDS(--)
Band numbers. The band numbers of the DDR file which will receive the values of the following parameters: MINVAL, MAXVAL, MMVAL, DSOURCE, VARIABLE (or SENSOR), DESCRIP (or CAPDIR), DATE (or CDATE), and TIME (or CTIME). The number of values specified in BANDS must be equal to the number of values specified in these parameters. If BANDS has a null value and only one value is specified in these parameters, the value of each of the parameters will be propagated to all the bands.

MINVAL(--)
Minimum value. The minimum intensity value.

There are only three valid ways to specify this parameter. One is to allow it to default. The second is to enter one value, and this value is automatically propagated to all the bands if BANDS is: -- (null value). The final way is to individually specify a value for each band specified in BANDS. The number of values specified in MINVAL and BANDS must be equal.

MAXVAL(--)
Maximum value. The maximum intensity value.

There are only three valid ways to specify this parameter. One is to allow it to default. The second is to enter one value, and this value is automatically propagated to all the bands if BANDS is: -- (null value). The final way is to individually specify a value for each band specified in BANDS. The number of values specified in MAXVAL and BANDS must be equal.

MMVAL(--)
Min/max validity. The validity of the minimum and maximum values for each band.


  = IN:   Invalid.  The value is known to be invalid.
  = VAL:  Valid.  The value is known to be valid.
  = BO:   Bounded.  The values of the image are within 
	  MINVAL and MAXVAL.

There are only three valid ways to specify this parameter. One is to allow it to default. The second is to enter one value, and this value is automatically propagated to all the bands if BANDS is -- (null value). The final way is to individually specify a value for each band specified in BANDS. The number of values specified in MMVAL and BANDS must be equal.

DSOURCE(--)
Data source. The source of the data.

There are only three valid ways to specify this parameter. One is to allow it to default. The second is to enter one value, and this value is automatically propagated to all the bands if BANDS is: -- (null value). The final way is to individually specify a value for each band specified in BANDS. The number of values specified in DSOURCE and BANDS must be equal. The current standard data sources include the following (but are not limited to):


  dem
  spot
  landsat-1, landsat-2, landsat-3, landsat-4, landsat-5, 
  landsat-7, noaa-6, noaa-7, noaa-8, noaa-9, noaa-10, noaa-11

VARIABLE(--)
Name of variable. The variable recorded in the band. For many types of data, this field should include units of measurement.

There are only three valid ways to specify this parameter. One is to allow it to default. The second is to enter one value, and this value is automatically propagated to all the bands if BANDS is: -- (null value). The final way is to individually specify a value for each band specified in BANDS. The number of values specified in VARIABLE and BANDS must be equal. The current standard ones include the following (but are not limited to):


   dem
   mss
   rbv
   tm

SENSOR(--)
Sensor type. The direction of sensor or instrument.

This is an alternative name for the VARIABLE parameter, intended for use with remotely sensed imagery.

There are only three valid ways to specify this parameter. One is to allow it to default. The second is to enter one value, and this value is automatically propagated to all the bands if BANDS is: -- (null value). The final way is to individually specify a value for each band specified in BANDS. The number of values specified in SENSOR and BANDS must be equal. The current standard ones include the following (but are not limited to):

   mss
   rbv
   tm

DESCRIP(--)
Fuller description of variable.

There are only three valid ways to specify this parameter. One is to allow it to default. The second is to enter one value, and this value is automatically propagated to all the bands if BANDS is: -- (null value). The final way is to individually specify a value for each band specified in BANDS. The number of values specified in DESCRIP and BANDS must be equal.

CAPDIR(--)
Capture direction. The direction of the capture process.

This is an alternative name for the DESCRIP parameter, intended for use with satellite imagery.


Example:  ascending or descending

There are only three valid ways to specify this parameter. One is to allow it to default. The second is to enter one value, and this value is automatically propagated to all the bands if BANDS is: -- (null value). The final way is to individually specify a value for each band specified in BANDS. The number of values specified in CAPDIR and BANDS must be equal.

DATE(--)
Date associated with variable. This may be used to record, for example, the acquisition date of raw data, the completion date of an analysis, or the date for the event being simulated by a model. The date should be entered using the "dd-mmm-yy" format.


Example:  

December 31, 1986 should be entered as 31-dec-86 
        (with month in lower case)

There are only three valid ways to specify this parameter. One is to allow it to default. The second is to enter one value, and this value is automatically propagated to all the bands if BANDS is: -- (null value). The final way is to individually specify a value for each band specified in BANDS. The number of values specified in DATE and BANDS must be equal.

CDATE(--)
Capture date. The date on which the data was captured.

This is an alternative name for the DATE parameter, intended for use with remotely sensed imgery. The date should be entered using the "dd-mmm-yy" format.


Example:  

December 31, 1986 should be entered as 31-dec-86 
        (with month in lower case)

There are only three valid ways to specify this parameter. One is to allow it to default. The second is to enter one value, and this value is automatically propagated to all the bands if BANDS is: -- (null value). The final way is to individually specify a value for each band specified in BANDS. The number of values specified in CDATE and BANDS must be equal.

TIME(--)
Time associated with variable. This is the time of day at which, for example, the raw data were captured or the time-step of a model ended. The time should be entered using a twenty-four hour clock; seconds are separated by a colon.


Example:  

1:05:55 p.m. should be entered as 1305:55

There are only three valid ways to specify this parameter. One is to allow it to default. The second is to enter one value, and this value is automatically propagated to all the bands if BANDS is: -- (null value). The final way is to individually specify a value for each band specified in BANDS. The number of values specified in TIME and BANDS must be equal.

CTIME(--)
Capture time. The time at which the data was captured.

This is an alternate name for parameter TIME, intended for use with remotely sensed data. The time should be entered using a twenty-four hour clock; seconds are separated by a colon.


Example:  

1:05:55 p.m. should be entered as 1305:55

There are only three valid ways to specify this parameter. One is to allow it to default. The second is to enter one value, and this value is automatically propagated to all the bands if BANDS is: -- (null value). The final way is to individually specify a value for each band specified in BANDS. The number of values specified in CTIME and BANDS must be equal.

Examples:

  1. LAS> editddr-screen in=test

    EDITDDR will read the contents of TEST.DDR. The values of each of the fields will be printed to the terminal screen. The user then interactively edits any of the fields on the screen. These changes will only be written to TEST.DDR when the WRITE command is invoked. The session will end and the completion message is displayed when the QUIT command is invoked.

  2. LAS> editddr-tutor in=test nl=1024 ns=1024 odtype=i*2

    EDITDDR will read the contents of TEST.DDR and change the contents of the fields NL to 1024, NS to 1024, and DTYPE to INTEGER*2. The parameters (fields) that were defaulted by the user will not be changed. All the values of the fields will be written back to TEST.DDR.

Description/Algorithm:

SUBCOMMAND -SCREEN

EDITDDR reads the contents of the input DDR file. The values of each of the fields are printed to the terminal screen. The user can then interactively edit any of the fields on the screen. These changes are only written to the input DDR file when the WRITE command is invoked. The session ends and the completion message is displayed when the QUIT command is invoked.

Valid commands of the -SCREEN subcommand:
   help  -- retrieve help for any of the DDR fields
   page  -- go to the next screen of information
   quit  -- end the session
   write -- write the changes to the DDR file

Subcommand -TUTOR

If the DDR file exists, EDITDDR reads the contents of the file and then changes the contents of the fields for which the user enters values. The parameters (fields) that were defaulted by the user are not changed. All the values of the fields are written back to the DDR file specified by the parameter IN.

If the DDR file does not exist--NL, NS, NBANDS, and ODTYPE are then required parameters. All other parameters that were defaulted by the user have a value of zero or a blank with the following exceptions:


1.  The validity flags are set according to the TAE global
    $DDRVFLG.  (See LASGBLS.)
2.  The system field will be updated.
3.  The last modified date and time fields are updated.

Nonfatal Error Messages:

  1. [editddr-band] Invalid band number

    An invalid band number was specified. Re-enter a valid band number.

  2. [editddr-code] Invalid <XXXX> command code

    An invalid <XXXX> command code was entered. Retype the command with the correct code. The upper-case letters or a combination of the upper-case letters should be used as the edit command code.

  3. [editddr-datum] Invalid datum code

    An invalid datum code was specified. Re-enter a valid datum code. See parameter DCODE for a valid list.

  4. [editddr-image] Invalid image name

    An invalid image name was specified. Respecify the image name with the correct syntax.

  5. [editddr-input] Input is larger than buffer size

    The string that was input is larger than the size of the input buffer. Since the input string is larger than the buffer size, the string is probably invalid. Re-enter a shorter string.

  6. [editddr-length] String length is too long

    The length of the input string is too long for the width of the field within the DDR. Shorten the input string.

  7. [editddr-nband] Invalid number of bands

    An invalid number of bands was specified. Re-enter a valid number of bands.

  8. [editddr-nline] Invalid number of lines

    An invalid number of lines was specified. Re-enter a valid number of lines.

  9. [editddr-nsamp] Invalid number of samples

    An invalid number of lines was specified. Re-enter a valid number of samples.

  10. [editddr-projtype] Invalid projection type

    An invalid projection type was entered. Retype the command with a valid projection type. See PROJTYPE parameter for valid projection types.

  11. [editddr-syntax] Invalid syntax of an edit command

    The edit command was not entered in correct syntax. Retype the command with the correct syntax as follows.

    edit command code = new value

  12. [editddr-type] Invalid data type

    An invalid data type was entered. Retype the command with the correct data type. A listing of valid data types follows.

    	BYTE: BYTE
    	I*2:  INTEGER*2
    	I*4:  INTEGER*4
    	R*4:  REAL*4
    

  13. [editddr-value] Unacceptable valid value

    An unacceptable value was entered for the VALID field. Retype the command with a correct value. A listing of correct values follows.

    
    	IN:  Invalid
    	VAL: Valid
    	UN:  Unknown
    

  14. [editddr-zone] Invalid zone code

    An invalid zone code was specified. Re-enter a valid zone code. Refer to the Geometric Manipulation Package Overview Document (GEOMPOD) for valid zone codes.

Fatal Error Messages:

  1. [editddr-create] <XXXXX> is required when a DDR is being created

    <XXXXX> is a required parameter in order to create a valid new DDR file. Enter a valid value into the <XXXXX> parameter.

  2. [editddr-count] Invalid number of values entered for <XXXXX>

    The number of values entered for the band dependent parameters should be one or equal to the number of values specified for the parameter BANDS. Re-enter the correct number of values. If only one value is entered, the value will be propagated to all the bands.

  3. [editddr-device] Device is not a terminal

    The device from which this module was initiated is not a terminal. To use this module with the subcommand -TUTOR, this module must be initiated on a terminal and not in batch.

  4. [editddr-display] Terminal has too few lines of display area

    The terminal from which this module was initiated does not have enough lines in which to display the contents of the DDR correctly. Initiate this module using the subcommand -SCREEN or initiate this module from a terminal that has at least 24 lines of display.

  5. [editddr-fatal] Fatal error encountered

    A fatal error was encountered during processing. The output image file is not deleted, and processing is terminated. The message that is displayed immediately preceding this error message is the specific error that was encountered.

  6. [editddr-input] Input file could not be found

    The input DDR file could not be found. Check to see that the DDR file exists.

  7. [editddr-terminal] Terminal is not supported by TAE I/O

    The terminal from which this module was initiated is not supported by TAE terminal I/O. Initiate this module on a terminal that is supported by TAE terminal I/O. Consult the TAE Users' Manual for a list of valid terminal types.

  8. [editddr-write] Error writing to the DDR file

    An error occurred while writing the DDR file. Verify that disk space is available.

User Note:

  1. Related module includes DSPDDR.