Usage: java -jar Hipsgen in=dir [otherParams ...ACTIONs...]
java -jar Hipsgen -param=configfile [...ACTIONs...]
java -jar Hipsgen -h
java -jar Hipsgen -man [param|ACTION]
HiPS generator from a set of source images. Provides additional
HiPS manipulation utilities (duplication, concatenation, checking, etc).
The parameters are provided in the configfile, or directly on the command line.
Default actions: INDEX TILES PNG CHECKCODE DETAILS
Available options:
-clean : Delete previous computations
-n : Just print process information, but do not execute it
-color : Colorize console log messages
-nocolor: Uncolorize console log messages
-nice : [MIRROR] Slow download for avoiding to overload remote http server
-notouch: Do not touch the hips_release_date
-hhhcar : [INDEX] Generate hhh file for an all sky image
-trim : [TILES,CONCAT,APPEND] Trim FITS tiles if possible
-gzip : [TILES,CONCAT,APPEND] Gzip FITS tiles
-d : Debug messages
-h : Inline help
-man : Full inline man (may bo followed by a parameter or an action for a full explanation)
Ex: java -jar Hipsgen in=/MyImg id=AUT/P/myhips => Do all the job
java -jar Hipsgen in=/MyImg id=AUT/P/myhips INDEX TILES
=> Generate the spatial index and the FITS tiles only
java -jar Hipsgen in=HiPS1 out=HiPS2 CONCAT => Concatenate HiPS1 to HiPS2
java -jar Hipsgen in=http://remote/hips MIRROR => copy the remote HiPS locally
(c) Université de Strasbourg/CNRS 2018-2023 - Hipsgen based on Aladin v12.031 from CDS
DESCRIPTION
The INDEX action generates the spatial index needed to build the HiPS. This spatial index is stored in a dedicated HpxFinder directory at the root of the final HiPS. It has the same structure as a HiPS with the difference that each tile of this index does not contain pixels but the list of original images intersecting the tile. The format used is ASCII JSON, one record per line. This index is eventually completed by the DETAILS action to allow access to the characteristics of the source images when visualizing the final HiPS. The main associated parameters are `order` to adjust the HiPS resolution, `hdu` to specify the correct image in multi-extension FITS and `fitskeys` to specifically store some characteristics of the original images. In the case of compressed images, the `cache` parameter is used to manage the disk buffer needed for decompression.
EXAMPLE
java -jar Hipsgen.jar in=/data/img out=/data/hips hdu=all INDEX
DESCRIPTION
The TILES action generates the HiPS tiles in the target directory (see out parameter) from the source images (see in parameter). Except in the case where the source data are extracted from a Healpix card, the INDEX action must necessarily have been executed previously. The transcription of the pixels depends on the nature of the original images, and may be controlled by the `bitpix` and `dataRange` parameters. The method used for the various pixel co-additions also depends on various parameters, the main one being `mode`.) Finally, the performance obtained can be adjusted by the `maxThread` and `partitioning` parameters. Pixels not taken into account will appear transparent (see `blank`, `pixelGood` `fov` and `border` parameters). The TILES action also updates the HiPS characteristics `properties` file, generates the HiPS spatial coverage (see `MOC` action), the HiPS cover page (`index.html` file) and, eventually, the Order3 `Allsky` file (see `ALLSKY` action).
EXAMPLE
java -jar Hipsgen.jar in=/data/img out=/data/hips maxThread=6 TILES
DESCRIPTION
The PNG action generates tiles for the preview of a HiPS. They are built from the FITS tiles that were previously generated by the TILES action. These tiles use the PNG format in 8 bits per pixel. The `hips_pixel_cut` parameter allows you to specify how pixels are mapped in this value range.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips pixelCut="10 800" PNG
DESCRIPTION
The JPEG action generates preview tiles in JPEG format. This is an alternative to the PNG action. JPEG tiles are generally smaller and faster to generate than their PNG counterpart, but do not have a transparency channel, so blank pixels will appear black and not transparent.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips pixelCut="10 800" JPG
DESCRIPTION
The MOC action (re)generates the `Moc.fits` file describing the spatial coverage of the HiPS. This action is rarely necessary as it is already performed by the other actions when necessary, unless you wish to modify the resolution of the generated MOC. The `mocorder` parameter allows to impose the order of the Moc to be generated.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips MOC
DESCRIPTION
The MAP action generates an HEALPix map from a HiPS. This HiPS must provide FITS tiles. The nside parameter allows to modify the resolution (by default the resolution of the HiPS). Be careful to indicate a reasonable nside size (<= 4096) to avoid producing a map that is too large to be usable.
EXAMPLE
java -jar Hipsgen.jar in=/data/hips out=/data/map.fits MAP
DESCRIPTION
The ALLSKY action (re)generates the `Allsky' auxiliary file for all used formats (fits, png, jpeg) for HiPS order 3 (=> in the Norder3 directory). As this action is executed automatically and by default at the end of the tile generation (action `TILES`), it is rarely useful individually.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips ALLSKY
DESCRIPTION
The CLEAN action deletes all HiPS tiles, subdirectories and HiPS auxiliary files except the `properties` file.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips CLEAN
DESCRIPTION
The CLEANINDEX action fully deletes the spatial index (HpxFinder directory)
EXAMPLE
java -jar Hipsgen.jar out=/data/hips CLEANINDEX
DESCRIPTION
The CLEANFITS action deletes all FITS tiles (+Allsky.fits) and any empty subdirectories.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips CLEANFITS
DESCRIPTION
The CLEANJPEG action deletes all JPEG tiles (+Allsky.jpg) and any empty subdirectories.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips CLEANJPEG
DESCRIPTION
The CLEANPNG action deletes all PNG tiles (+Allsky.png) and any empty subdirectories.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips CLEANPNG
DESCRIPTION
Removes weight tiles. Weight tiles are generated by the incremental=true option. They allow HiPS updates to be made while respecting the weighting on the pixels. Without scheduled updates, these tiles are not needed and double the size of the HiPS unnecessarily.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips CLEANWEIGHT
DESCRIPTION
The TREE action builds, or rebuilds, the HiPS hierarchy from the deepest order tiles. This operation is rarely necessary as it is already done by TILES action,unless you have modified or generated the deepest order tiles by methods other than Hipsgen.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips TREE
DESCRIPTION
The APPEND action adds new images to a pre-existing HIPS. This can be done on a HiPS for which the original images are no longer available. The parameters used to build the original HiPS will be used to process the new images. The generated HiPS pixels will be added to the existing HiPS or averaged if they are already present. This default behaviour can be modified by the `mode` parameter. In case the original HiPS was created with the `-live` option, the average will be weighted by the number of progenitors.
EXAMPLE
java -jar Hipsgen.jar in=/data/newImgs out=/data/hips APPEND
DESCRIPTION
The CONCAT action merges one HiPS into another. The two HiPS must be compatible (same bitpix, frame, order and tile format). Common pixels are averaged. The `mode` parameter is used to change this default behaviour. The average will be weighted by the number of progenitors in case the HiPS to be merged have weight tiles (option -live). Concatenation is also applied to the spatial index information (HpxFinder). See the APPEND action to perform a simple addition of images to an existing HiPS.
EXAMPLE
java -jar Hipsgen.jar in=/data/hipsToAdd out=/data/hips CONCAT
DESCRIPTION
The CUBE action generates a HiPS cube from 2 or more pre-existing HiPS. These HiPS must be compatible (same bitpix, frame, order and format). They are indicated by means of the `in` parameter using the semicolon as separator. Tiles from the original HiPS are copied into the target HiPS cube. The `mode=link` parameter allows to change this default behaviour by using relative symbolic links on the original tiles.
EXAMPLE
java -jar Hipsgen.jar in=/data/hips0;...;/data/hipsN out=/data/hips CUBE
DESCRIPTION
The DETAILS action extends the spatial index generated by the INDEX action to make accessible the characteristics of each original image (date of observation, exposure time, etc), and even to provide direct links to these images. This action generates a hierarchy of metadata tiles, directly in the HpxFinder spatial index directory, and sets up a mapping file `metada.xml`. Editing this file allows you to adjust the features to be made accessible.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips DETAILS
DESCRIPTION
Generates a file `STMoc.fits` at the root of the HiPS. This describes the space-time coverage of the HiPS. It is based on the information collected during the INDEX action to determine the observation date and duration associated with each HiPS tile (takes into account all images contributing to the tile).
EXAMPLE
java -jar Hipsgen.jar out=/data/hips STMOC
DESCRIPTION
If necessary, the UPDATE action upgrades the HiPS designated by the `out` parameter to be compliant with the IVOA HiPS 1.0 standard (=hips_version 1.4). This operation also may update the compliance codes (DATASUM and `hips_check_code`) and the `hips_nb_tiles` and `hips_extsize` metrics.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips UPDATE
DESCRIPTION
The CHECKCODE action calculates the numerical check codes allowing to verify a posteriori that the number and size of the tiles are unchanged (see CHECK action). These codes are stored in the `properties` file in the `hips_check_codes` field. The `hips_nb_tiles` and `hips_estsize` fields are also updated. If previous values have already been stored, it is necessary to use the `-clean` option to force their replacement.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips CHECKCODE
DESCRIPTION
The MIRROR action makes a copy of a HiPS, local or remote. The `in` parameter specifies the directory of the HiPS or its URL for remote copy. The copy will be total by default or partial using the `format` parameter to specify the format(s) of the tiles involved (fits, png or jpg), and/or the `order` parameter to restrict the order of the copied HiPS, and/or `region` to consider only a spatial portion of the HiPS. The `split` parameter allows the resulting HiPS to be spread over several directories. In the case of a remote copy, the -nice option deliberately slow down the copy to avoid overloading (and possibly being banned) from the server. When resuming an interrupted copy, the -nocheck option accelerate and simplify the verification of the already copied tiles (do not compare the dates and sizes).
EXAMPLE
java -jar Hipsgen.jar in=http://remote/hips out=/data/hips MIRROR
DESCRIPTION
The RGB action generates a colour HiPS from 3 greyscale HiPS, each of which will be used for one of the red, green and blue colour components. The parameters inRed, inGreen, inBlue designate the original HiPS. Two methods can be used. 1 - The classic method which uses the parameters cmRed, cmGreen and cmBlue by explicitly specifying the pixel mapping of each HiPS. 2 - The Lupton method which uses the parameters luptonM, luptonS and luptonQ. The omission of a HiPS will be handled by using the average of the values of the other two.
EXAMPLE
java -jar Hipsgen.jar inRed=hips1 inGreen=hips2 inBlue=hips3 out=hipsRGB RGB
DESCRIPTION
The CHECK action controls the conformity of the security codes stored in the `properties' file to the tiles present in the HiPS. This is a fast test to check that no tile has been deleted or modified, for example after a HiPS copy (see MIRROR action). For a more elaborate check, see the CHECKDATASUM action.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips CHECK
DESCRIPTION
The CHECKDATASUM action checks the integrity of FITS tiles. When generating tiles with a recent version of Hipsgen (>12.010), or as a result of the UPDATEDATASUM action, each FITS tile has a numerical code (DATASUM) in its header linked to its content. CHECKDATASUM recalculates the numerical code of each tile and verifies that it corresponds to the one that was stored in the header. This operation requires a lot of computing time, depending on the context, it may be sufficient to check the integrity of a HiPS only by the size and number of tiles (see CHECK action), This operation requires a lot of computing time, depending on the context, it may be sufficient to check the integrity of a HiPS only by the size and number of tiles (cf. CHECK action) or only by a few tiles chosen randomly (cf. CHECKFAST action).
EXAMPLE
java -jar Hipsgen.jar out=/data/hips CHECKDATASUM
DESCRIPTION
The CHECKFAST action tests the integrity of a HiPS by checking the compliance of some randomly designated tiles. This action is a fast alternative to the CHECKDATASUM action, and allows to detect a possible corruption of a HiPS following the activation of a ransomware.
EXAMPLE
java -jar Hipsgen.jar out=/data/hips CHECKFAST
DESCRIPTION
The LINT action checks that the HiPS specified by the out parameter is compliant with the IVOA HiPS 1.0 standard. If not, it indicates the non-conforming elements.
DESCRIPTION
The MAPTILES action generates the FITS tiles and the HiPS hierarchy from a HEALPix map. This map must be specified with the `in` parameter and replaces the source images. The resulting HiPS takes the same coordinate frame and pixel coding as the HEALPix map (see `frame` parameter). Thus, by default the HiPS pixel values will be strictly identical to those of the original map (no resampling, no coding changes). The HEALPix map can be expressed in RING or NESTED coding. It can have implicit or explicit addressing.
EXAMPLE
java -jar Hipsgen.jar in=/data/map.fits out=/data/hips MAPTILES
SYNOPSIS
in=dir
DESCRIPTION
Indicates the directory that contains the source images (FITS, PNG, JPEG (+ HHH)). If there is only one image, the directory name can be replaced by the file name. The source images can be directly localized in the directory or in one of its subdirectories. In the case of MIRROR, MAP, CONCAT actions, indicate the source HiPS.
SYNOPSIS
out=dir
DESCRIPTION
Specifies the output directory. If not specified, it will be created at the same level as the source directory using the HiPS identifier as directory name (see id parameter).
SYNOPSIS
order=nn
ALIAS hips_order
ACTIONS
DESCRIPTION
Specifies the HiPS order. By default, the HiPS order is calculated to obtain a resolution equivalent to, or slightly better than, the original images (based on the reference image - see img parameter). Altering the default value is intended to oversample, or undersample, the output HiPS. Note that each additional order quadruples the size of the resulting HiPS.
SYNOPSIS
minOrder=nn
ALIAS hips_min_order
ACTIONS
DESCRIPTION
Specifies the minimum order of the HiPS. The default is 0. Altering this setting is not recommended unless you want to generate a partial HiPS and then rebuild the tree afterwards (see action TREE).
SYNOPSIS
frame=equatorial|galactic|ecliptic
ALIAS hips_frame
ACTIONS
DESCRIPTION
Indicates the coordinate system of the HiPS. By default a HiPS is equatorial (ICRS) and it is recommended to keep this value except in the case where the HiPS is generated directly from a HEALPix map which is not equatorial.
SYNOPSIS
tileWidth=nn
ALIAS hips_tile_width
ACTIONS
DESCRIPTION
Specifies the size of HiPS tiles by indicating the number of pixels on one side (necessarily a power of 2). The default is 512 (x 512) pixels. This value can be reduced to limit null edges, especially for very fragmented HiPS (e.g. 128). On the contrary, it can be increased to reduce the number of tiles (e.g. 1024).
SYNOPSIS
bitpix=8|16|32|64|-32|-64
ALIAS hips_pixel_bitpix
ACTIONS
DESCRIPTION
Specifies the pixel encoding of the HiPS. Follows the FITS convention: 8, 16, 32, 64 for 8, 16, 32 or 64 bit integer encoding, -32 or -64 for 32 (float) or 64 (double) bit real encoding. By default, uses the same encoding as the original images (standard image - see img parameter). Reducing the number of bits mechanically reduces the size of the final HiPS. But it also reduces the number of possible values and introduces rounding phenomena. In this situation, it is recommended to check the range of values selected, and if necessary modify it (cf. dataRange parameter).
SYNOPSIS
dataRange=min max
ALIAS hips_data_range
ACTIONS
DESCRIPTION
Specifies the range of pixel values to be considered when performing a pixel encoding conversion (see bitpix parameter). All values below or above will be considered equal to the smallest or largest value respectively. By default, this value range is automatically determined from the reference image taken from the source images (see img parameter). The specified values are to be considered as physical pixel values (i.e. taking into account a possible linear bzero/bscale operation on the encoded pixel values)
SYNOPSIS
pixelCut=min max [fct]
ALIAS hips_pixel_cut
ACTIONS
DESCRIPTION
Specifies the range of pixel values and how these pixels will be rendered in the HiPS preview tiles (PNG or JPG). The pixel values between min and max are distributed over the 255 (resp. 256) possible values using by default a linear change, or one of the possible transfer functions (log, sqrt, asinh, pow2). The specified values are to be considered as physical pixel values (i.e. taking into account a possible linear bzero/bscale operation on the encoded pixel values)
SYNOPSIS
img=filename
ACTIONS
DESCRIPTION
Indicates the file name of the source image used as a reference. This image determines the parameters of the final HiPS: order, pixel encoding, value ranges, etc. By default, the first image in the source directory will be used. If it is not representative, an alternative image is recommended.
SYNOPSIS
hdu=n1,n2-n3,...|all
ACTIONS
DESCRIPTION
Specifies the extension numbers of the original FITS images to be considered for HiPS generation. By default, only the first FITS extension containing a valid image is taken into account. The first extension has the number 0.
SYNOPSIS
blank=nn|key
ACTIONS
DESCRIPTION
Specifies an alternative pixel value to be considered null. This value would normally have been specified directly in the FITS image header using the BLANK keyword. The indicated value is to be considered at the FITS coding level, i.e. without taking into account a possible linear bzero/bscale change.
SYNOPSIS
validRange=min max
ACTIONS
DESCRIPTION
Specifies the range of valid pixels. All other values are considered null (see `blank` parameter). Note that, unlike the blank parameter, the min and max values are to be considered as physical pixel values (for which a linear bzero/bscale change will already have been applied). This parameter should not be confused with `dataRange` (describes the range of values retained for a pixel coding conversion). In the first case, values outside the range correspond to a transparent (or non-existent) pixel, in the second case, the pixel is reduced to the smallest, respectively largest possible pixel value.
SYNOPSIS
skyVal=key|auto|%info|%min %max
ACTIONS
DESCRIPTION
Sky background removal method. Specifies either the FITS keyword to be used to find out the sky background value or the values to be applied for the automatic method. In the second case, 1 value represents the percentage of the histogram of detected pixel values to be retained; 2 values represent the min and max of the histogram to be retained (central ex 99, or min max ex 0.3 99.7)
SYNOPSIS
expTime=key
ACTIONS
DESCRIPTION
Indicates the FITS keyword associated with the exposure time of the original images. Activates the division of the original pixels by this exposure time.
SYNOPSIS
maxRatio=nn
ACTIONS
DESCRIPTION
Security filtering of source images. Specifies the maximum tolerated ratio of the angular size of a pixel in longitude and latitude to consider a source image as correct. By default, a ratio greater than 3 causes the image to be rejected.
SYNOPSIS
fov=true|x1,y1..
ACTIONS
DESCRIPTION
Mask activation by polygon or circle allowing to define a field of view, or any sub-area in the original image. These masks are provided in the form of a file with the same name as the image to which it is associated, but with the extension `.fov'. This file contains the cartesian coordinates of the mask: one pair of X Y coordinates (FITS convention) per line describing the polygon in a counter-clockwise direction, or a single `X Y radius` triplet in the case of a circle. The `.fov` file associated to a directory is applied to all the images in the directory and its sub-directories, except for images having their own `.fov` file. When the mask is constant for all images, it can be directly provided as a parameter value. See the `border` parameter for basic edge masking.
SYNOPSIS
border=nn|N W S E
ACTIONS
DESCRIPTION
Remove the edges of original images. This masking is constant for all images. It is expressed either as a single value indicating the number of pixels to be ignored on the 4 edges, or as a quadruplet N W S E indicating the number of pixels to be ignored respectively at the top, left, bottom and right of the images. For more advanced masking, see the `fov` parameter.
SYNOPSIS
shape=rectangle|ellipse
ACTIONS
DESCRIPTION
Indicates the shape of the field of view of the original images. Activates the autodetection of the pixels to be taken into account according to this shape.
SYNOPSIS
mode=m1,m2..
DESCRIPTION
Pixel coaddition modes. Concerns overlays of original images (overlayMean, overlayAdd, overlayNone, overlayFading), tile merges for HiPS updates (mergeOverwrite, mergeKeep, mergeMean, mergeAdd, mergeSub, mergeMul, mergeDiv, mergeKeepTile, mergeOverwriteTile), HiPS hierarchy pixel aggregations (treeMean, treeMedian, treeMiddle, treeFirst). The use of a common suffix is valid for all associated modes (e.g. mode=add is equivalent to mode=overlayAdd,mergeAdd).
SYNOPSIS
incremental=false|true
ACTIONS
DESCRIPTION
Activates the memorization of the weights assigned to each HiPS pixel in order to be able to add new images afterwards, or concatenate two HiPS while keeping a weighting proportional to the number of source images that contributed to the calculation of each pixel. By default, this option is disabled because it doubles the final size of the HiPS (generates weight tiles).
SYNOPSIS
region=inline moc|moc.fits
DESCRIPTION
Reduces the working region. The syntax may be an inline ASCII MOC, ex: `orderA/npix1 npix2-npix3 ... orderB/npix`. It indicates the HEALPix indices of the area concerned. It can also be a file name containing a binary MOC (.fits extension).Without this parameter, the whole sphere is processed.
SYNOPSIS
partitioning=false|nnn
ACTIONS
DESCRIPTION
By default, the original images are processed in blocks of 4096 x 4096 pixels. This partitioning mechanism can be removed (value: `false`) or modified (value: block width). Small blocks save RAM but slow down processing.
SYNOPSIS
maxThread=nn
DESCRIPTION
By default, all available CPU cores are used in order to operate as fast as possible. Limiting the number of cores allows the machine to keep power for other tasks.
SYNOPSIS
fastCheck=true|false
ACTIONS
DESCRIPTION
Specifies how previously copied tiles will be checked in the particular context of a duplicate copy (`MIRROR` action). By default, the check is fast, and is based only on a reasonable size of the tile, with no exchange with the server providing the original HiPS. By forcing this parameter to `false`, the check will be more complete to ensure that the size and date is consistent, but much slower, especially when the HiPS was almost copied entirely. Note that the `MIRROR` action will do a CHECK action anyway if the HiPS to be copied provides these digital keys.
SYNOPSIS
fitsKeys=key1,key2...
ACTIONS
DESCRIPTION
The INDEX and DETAILS actions respectively record and provide the characteristics of the original images (observation date, exposure time, etc). A list of common keywords is used by default to enumerate these characteristics and store them in the HpxFinder spatial index tiles. This parameter allows to substitute the default list with specific keywords.
SYNOPSIS
id=AUTH/P/...
ALIAS creator_did
DESCRIPTION
Conforms to the IVOA syntax `AUTHORITY/P/...` (e.g. CDS/P/DSS/E). The assignment of a unique identifier is strongly recommended, and is essential when the HiPS is distributed. The authority is usually an acronym of the institution, the separator `/P/` is specific to `P`ixel HiPS, and the end of the identifier describes the HiPS, usually the name of the mission, and its main feature(s) (slash `/` is recommended as a separator rather than underscore `_`).
SYNOPSIS
title=title
ALIAS hips_title
DESCRIPTION
The title of the HiPS should describe it in a few words (e.g. ZTF DR7 g). Assigning a title is strongly recommended and will by default be built from the identifier (see `id` parameter).
SYNOPSIS
creator=name
ALIAS hips_creator
DESCRIPTION
Name of the person and/or institute that generated the HiPS.
SYNOPSIS
target=ra dec [rad]
DESCRIPTION
Default RA DEC display position (format: real real real (ICRS frame, unit: degrees) .If not specified, central position of the first image (reference image).
SYNOPSIS
status=private|public [clonable|clonableOnce|unclonable]
ALIAS hips_status
DESCRIPTION
Status of HiPS. The default is `public` for free browsing, and `clonableOnce` to allow duplication but only from this instance. Can be changed to `private` to restrict browsing, and `clonable` or `unclonable` to change duplication rights.
SYNOPSIS
color=jpeg|png
ACTIONS
DESCRIPTION
In case the original images are jpeg or png colour files, or with the RGB action, specify the HiPS colour format. By default, keeps the original image format.
SYNOPSIS
inRed=hipspath
ACTIONS
DESCRIPTION
Indicates the path of the original HiPS when using an `RGB` action to calculate the red component.
SYNOPSIS
inGreen=hipspath
ACTIONS
DESCRIPTION
Indicates the path of the original HiPS when using an `RGB` action to calculate the green component.
SYNOPSIS
inBlue=hipspath
ACTIONS
DESCRIPTION
Indicates the path of the original HiPS when using an `RGB` action to calculate the blue component.
SYNOPSIS
cmRed=min [mid] max [fct]
ACTIONS
DESCRIPTION
Method to convert the red component pixels for an `RGB` action. Specifies the range of original pixel values and the conversion function used (log, sqrt, linear (default), asinh, pow2) to map them to the 256 possible colour channel values.
SYNOPSIS
cmGreen=min [mid] max [fct]
ACTIONS
DESCRIPTION
Method to convert the green component pixels for an `RGB` action. Specifies the range of original pixel values and the conversion function used (log, sqrt, linear (default), asinh, pow2) to map them to the 256 possible colour channel values.
SYNOPSIS
cmBlue=min [mid] max [fct]
ACTIONS
DESCRIPTION
Method to convert the blue component pixels for an `RGB` action. Specifies the range of original pixel values and the conversion function used (log, sqrt, linear (default), asinh, pow2) to map them to the 256 possible colour channel values.
SYNOPSIS
luptonQ=x
ACTIONS
SYNOPSIS
luptonS=x/x/x
ACTIONS
SYNOPSIS
luptonM=x/x/x
ACTIONS
SYNOPSIS
cache=dir
ACTIONS
DESCRIPTION
Specifies a directory buffer instead of the one provided by the operating system. This buffer is used for decompressing the original images when necessary. See parameters cacheSize and cacheRemoveOnExit.
SYNOPSIS
cacheSize=nnMB
ACTIONS
DESCRIPTION
Indicates the maximum size of the buffer (see cache parameter). By default, the buffer is half a TB or less if the buffer partition does not allow it. The expected unit is MB.
SYNOPSIS
cacheRemoveOnExit=true|false
ACTIONS
DESCRIPTION
Indicates that the contents of the buffer should be preserved (or not) from one session to the next. This allows a session to be restarted without having to decompress images unnecessarily.
SYNOPSIS
mocOrder=nn [<nnMB]
ALIAS hips_moc_order
ACTIONS
DESCRIPTION
Specifies the resolution and/or size of the MOC associated with the HiPS (file `Moc.fits`, resp. `STMoc.fits`). By default the resolution of the MOC depends on the spatial distribution of the HiPS. If this coverage results in an overly large MOC, its resolution will automatically be degraded (but not below the order of the HiPS itself). This parameter allows to explicitly specify an order for the MOC, and/or a volume limit.
SYNOPSIS
mapNside=nn
ACTIONS
DESCRIPTION
Dedicated to the MAP action. Allows you to specify a particular NSIDE value (default 1024). For this resolution to be identical to the original HiPS it should correspond to the formula: nside = tileWidth x 2^order.
SYNOPSIS
mirrorFormat=fmt1 fmt2 ...
ALIAS tileFormat format
ACTIONS
DESCRIPTION
Dedicated to the MIRROR action. Specifies the list of tile formats to be copied (e.g. `fits jpeg` - by default all formats).
SYNOPSIS
mirrorSplit=size;altPath ...
ACTIONS
DESCRIPTION
Dedicated to the MIRROR action. Indicate one or more alternative directories needed for the copy if the default directory does not have the required size. For example `10g;/data/hips-ext1 200g;/data/hips-ext2` will cause the first 10GB to be copied into the default directory `out`, then 200GB into the alternative directory /data/hips-ext1, and all the rest into /data/hips-ext2
SYNOPSIS
pilot=nn
ACTIONS
DESCRIPTION
Dedicated to generating a `pilot' HIPS for testing. Indicates the number of original images to be considered.