Firefly

Namespace: image

firefly.util. image

Image utilities.

Source:

Namespaces

CCUtil

part of lowLevelApi

.

Methods

<static> getPrimePlot( [plotId])

Get plot object with the given plot id, when plotId is not included, active plot is returned.

Get plot object with the given plot id, when plotId is not included, active plot is returned.

Parameters:
Name Type Argument Description
plotId string <optional>

the plotId, optional
Source:
Returns:
Type
WebPlot

<static> getSelectedRegion(drawLayerId)

get the region description of the selected region from the specified drawing layer

Parameters:
Name Type Description
drawLayerId string

id of the drawing layer
Source:
Returns:

description of the selected region

Type
string

<static> initAutoReadout(ReadoutComponent, props)

initialize the auto readout. Must be call once at the begging to get the popup readout running.

Parameters:
Name Type Description
ReadoutComponent object

either a PopupMouseReadoutMinimal or PopupMouseReadoutFull
props object

a list of the properties
Source:

<static> serializeSimpleRangeValues(stretchType, lowerValue, upperValue, algorithm)

Parameters:
Name Type Description
stretchType

the type of stretch may be 'Percent', 'Absolute', 'Sigma'
lowerValue

lower value of stretch, based on stretchType
upperValue

upper value of stretch, based on stretchType
algorithm

the stretch algorithm to use, may be 'Linear', 'Log', 'LogLog', 'Equal', 'Squared', 'Sqrt'
Source:

<static> setDrawLayerDefaults(drawLayerTypeId, defaults)

Set a defaults object on for a draw layer type.

Set a defaults object on for a draw layer type. The following draw layers are supported: 'ACTIVE_TARGET_TYPE', 'CATALOG_TYPE'

Parameters:
Name Type Description
drawLayerTypeId string
defaults DrawingDef
Source:
See:
  • DrawingDef
  • DrawSymbol
Example
firefly.util.image.setDrawLayerDefaults('ACTIVE_TARGET_TYPE', {symbol:'x', color:'pink', size:15});
or
firefly util.image.setDrawLayerDefaults('CATALOG_TYPE', {symbol:'cross', color:'red'});