hdf images hdf images

HDP -- the HDF dumper

NAME

hdp - HDF dumper


SYNOPSIS

hdp [hdp options] hdp command [command options] <filename list>


DESCRIPTION

hdp is a command line utility designed for quick display of contents and data of HDF objects. It can list the contents of hdf files at various levels with different details. It can also dump the data of one or more specific objects in the file.


HDP OPTIONS

Currently, there is only one option.
    -H  Display usage information about the specified command.
        If no command is specified, -H lists all available commands.

HDP COMMANDS

hdp currently has two types of commands: list and dump. Other types of commands such as those for editing may be added in the future.
 
     hdp list 
         lists contents of files in  

     hdp dumpsds 
         displays data of NDGs and SDGs in the listed files.

     hdp dumpvd 
         displays data of vdatas in the listed files.
   
     hdp dumpvg 
         displays data of objects in vgroups in the listed files.

     hdp dumprig 
         displays data of RIGs in the listed files.

     hdp dumpgr 
         displays data of general RIGs in the listed files.
   

HDP COMMAND OPTIONS

(Note: options preceeded by an * have not yet been implemented.)

 hdp list [format options] [content ops] [filter ops] [order ops] <filename list>
 --------------------------------------------------------------------------

  Format options
      decide how the info of objects will be presented on the screen.
       
    -s  (short format) under each tag #, all ref's of that tag are listed
        in one or more lines, same as the output of hdfls. (default)

    -l  (long format) one object per line. Each line contains tag-name, 
        tag/ref and the index of this tag in the file.(e.g., the ith NDG 
        in the file).

    -d  debug format, one object per line. Each line contains tag_name,
            tag/ref, index, offset, and length, same as the output of hdfls -d.

        no  tagname    tag    ref   index/tag   offset  length
        --  -------    ---    ---   ---------   ------  ------

         1  DFTAG_NT   106      2       1          
         2  DFTAG_SD   701      3       1
        ...


  Content options
       allow contents be displayed.
  
    -n  display the name or label of the object, if there is any.
        -n puts you in -l format automatically.

    -c  display the class of the object, if there is any. -l format.

    -a  display description of the object, if there is any. -l format.

  Filter options
       select certain type of objects to display, default is all.

    -g  display groups only. Objects which do not belong to 
        any group will not be displayed. Nested groups will be
        displayed in tree format.

    -t <number>  display objects with specified tag number . e.g. 
                 720 for NDG.
    -t <name>    display objects with specified tag name.

  Order options
        sort the output list in different orders.
 
    -ot  by tag # (default)
    -of  by the order in file DDlist.
    -og  by group
    -on  by name(label)

 hdp dumpsds [filter ops] [contents ops] [output ops] <filename list>
 --------------------------------------------------------------------
  Filter options
        specify which SDS to dump.

    -i <index>   dump SDS's with indices specified in <index>; indices
                 correspond to the order of the SDS in the file
    -r <ref>     dump SDS's with reference numbers specified in <ref>
    -n <name>    dump SDS's with names specified in <name>
    -a           dump all SDS's in the file. (default)

  Content options

    -v    display everything including all annotations (default)
    -h    header only, no annotation for elements or data
    -d    data only, no tag/ref 

  Output options

    -o <fn>    specify fn as output file name
    -b         binary file
    -x         ascii text file (default)

  Note: Any combination of an option from each of the three categories
        can be used; but no more than one option from one category is 
        allowed.

 hdp dumpvd [filter ops] [contents ops] [output ops] <filename list>
 --------------------------------------------------------------------
  Filter options
        specify which vdata to dump.

    -i <index>   dump vdatas with indices in <index>; indices 
                 correspond to the order of the vdatas in the 
                 files
    -r <ref>     dump vdatas with reference numbers specified in
                 <ref>
    -n <name>    dump vdatas with names specified in <name>
    -c <class>   dump vdatas with classes specified in <class>
    -a           dump all vdatas in the file. (default)

  Content options

    -v    display everything including all annotations (default)
    -h    header only, no annotation for elements or data
    -d    data only, no tag/ref
    -f <fields> dump data of specified fields

  Output options

    -o <fn>    specify fn as output file name
  * -b         binary file
    -x         text ascii file (default)

 hdp dumpvg [filter ops] [contents ops] [output ops] <filename list>
 --------------------------------------------------------------------
  Filter options
        specify which vgroups to dump.

    -i <index>   dump vgroups with indices specified in <index>; 
                 indices correspond to the order of the vgroups 
                 specified in the files
    -r <ref>     dump vgroups with reference numbers specified in <ref>
    -n <name>    dump vgroups with names specified in <name>
    -c <class>   dump vgroups with classes specified in <class>
    -a           dump all vgroups in the file. (default)

  Content options

    -v    display everything including all annotations (default)
    -h    header only, no annotation for elements or data
    -d    data only

  Output options

    -o <fn>    specify fn as output file name

    Note: Unless the "-d" option is specified, a graphical representation of
	  the file will be given after the data has been displayed. 

 hdp dumprig [filter ops] [contents ops] [output ops] <filename list>
 --------------------------------------------------------------------
  Filter options
        specify which RIG to dump.

    -i <index>   dump RIGs with indices specified in <index>; 
                 indices correspond to the order of the RIGs 
                 specified in the files
    -r <ref>     dump RIGs with reference numbers specified in <ref>
    -a           dump all RIGs in the file. (default)
    -m  8|24     dump the RIGs of 8-bit or 24-bit. By default all
                 RIGs in the file will be dumped

  Content options

    -v    display everything including all annotations (default)
    -h    header only, no annotation for elements or data
    -d    data only

  Output options

    -o <fn>    specify fn as output file name
    -b         binary file
    -x         text ascii file (default)

 hdp dumpgr [filter ops] [contents ops] [output ops] <filename list>
 --------------------------------------------------------------------
  Filter options
        specify which general RIGs to dump.

    -i <index>   dump general RIG's with indices specified in 
                 <index>; indices correspond to the order of 
                 the RIG in the file
    -r <ref>     dump general RIG's with reference numbers 
                 specified in <ref>
    -n <name>    dump general RIG's with names specified in <name>
    -a           dump all general RIG's in the file. (default)

  Content options

    -v    display everything including all annotations (default)
    -h    header only, no annotation for elements or data
    -d    data only, no tag/ref

  Output options

    -o <fn>    specify fn as output file name
    -b         binary file
    -x         ascii text file (default)

  Note: Any combination of an option from each of the three categories
        can be used; but no more than one option from one category is
        allowed.

- - Last modified: 16 May 2011