auromat.cli.convert module

Converts a downloaded dataset into a given format (CDF and netCDF currently) and applies requested postprocessing steps like resampling.

auromat.cli.convert.main()

usage: auromat-convert [-h] [--data DATA] [--start START] [--end END]
                       [--altitude ALTITUDE] [--bps {8,16}] [--correctgamma]
                       [--autobright] [--resample] [--resolution RES]
                       [--grid {geo,mag}] [--out OUT] [--overwrite] [--skip]
                       --format {cdf,netcdf} [--without-bounds]
                       [--without-mag] [--without-geo] [--version]

This tool converts downloaded data to a new format and optionally
applies postprocessing like resampling.

optional arguments:
  -h, --help            show this help message and exit
  --data DATA           Data directory, by default the current directory. For
                        ESA ISS sequences, this must be the subfolder
                        corresponding to a single sequence, typically "seq-n".
                        Under Unix-type shells, use "--data seq-*" to process
                        all sequences.
  --version             show program's version number and exit

period:
  These arguments optionally specify which data to convert. If you used --start and/or --end in auromat-download, then the same values have to be used here as well.

  --start START         UTC start date, format 2000-01-01T12:00:00
  --end END             UTC end date (inclusive)

mapping:
  --altitude ALTITUDE   Altitude in km onto which to map the images, default
                        is 110km

ESA ISS data:
  --bps {8,16}          bits per sample, default is 16
  --correctgamma        Applies BT.709 gamma correction for creating visually
                        pleasing images. A nonlinear curve is applied which
                        brightens dark pixels more than bright ones to match
                        human perception. If --correctgamma is not used then a
                        more scientifically useful linear image is produced
                        where the number of photons hitting a pixel is in
                        linear relationship with the resulting pixel value.
  --autobright          Automatically brightens the image such that 1% of all
                        pixels are fully saturated. This may destroy
                        information in the image and should not be used when
                        doing a scientific analysis.

resampling:
  --resample            Whether to resample or not
  --resolution RES      in arcsec/px, default 100
  --grid {geo,mag}      The grid which will be regular after resampling.
                        Default is MLat/MLT grid. Use geo for geographical
                        grid.

output:
  --out OUT             Output directory, by default the "converted"
                        subdirectory of --data
  --overwrite           Overwrites existing files.
  --skip                Skips already converted files.
  --format {cdf,netcdf}
                        Data format of converted files
  --without-bounds      Do not include coordinates of pixel corners. If set,
                        then only the pixel center coordinates are written,
                        otherwise both.
  --without-mag         Do not include MLat/MLT coordinates.
  --without-geo         Do not include geodetic coordinates. Only usable with
                        CDF output.

Examples:

Convert everything in the current directory with default settings:
auromat-convert --format cdf

Convert data in iss/seq-1 folder with 100km mapping altitude:
auromat-convert --data iss/seq-1 --format cdf --altitude 100

Resample and convert data:
auromat-convert --format cdf --resample --resolution 80

Don't store pixel corner coordinates:
auromat-convert --format cdf --without-bounds

Note that if you called auromat-download with --start and/or --end
dates, then you have to specify these here as well.