Skip to main content

rpc-ideal

Use in conjunction with provided RPC data from the get image rpc endpoint.

Function: ideal

Description: The ideal function provides an ideal image output of the panchromatic band alone or any combination of available multispectral bands.

Function Parameters:

nametypedescriptionrequired
collect_identifierstringThe collect ID. See Collect ID descriptiontrue
bandsstringThe bands to include in the output image. default "red,green,blue". i.e. "pan", "red,green,blue", etc... See bands descriptionfalse
interpolationstringThe interpolation method to use when resampling. See interpolations methodsfalse
drabooleanIf true (default) the output will be an 8 bit DRA'd image, if false the output will be a 16 bit non-DRA'd image.false
hdbooleanIf true the output will HD'd to a higher resolution, if false (default) the output will remain at native resolution.false
ancillary_typestringThe ancillary data type to use. Defaults to null and appropriate type will be selected for the user. See ancillary type descriptionfalse

For constructing a valid service url with this function and desired parameters please see our URL Formation doc.


Function: pansharp

Description: The pansharp function provides a pan-sharpened ideal image output of any combination of available multispectral bands. Note that this function cannot be used with imagery that only has a panchromatic band, such as WV01 collects.

Function Parameters:

nametypedescriptionrequired
collect_identifierstringThe collect ID. See Collect ID descriptiontrue
bandsstringThe bands to include in the output image. Band cannot be "pan" for this function. default "red,green,blue. i.e. "red,green,blue", etc... See bands descriptionfalse
drabooleanIf true (default) the output will be an 8 bit DRA'd image, if false the output will be a 16 bit non-DRA'd image.false
hdbooleanIf true the output will HD'd to a higher resolution, if false (default) the output will remain at native resolution.false
ancillary_typestringThe ancillary data type to use. Defaults to null and appropriate type will be selected for the user. See ancillary type descriptionfalse

For constructing a valid service url with this function and desired parameters please see our URL Formation doc.