VisiOmatic web client

Global

Methods

catalogUI(catalogs, optionsopt) → {CatalogUI}

Instantiate a VisiOmatic dialog for catalog queries and catalog overlays.

Parameters

  • catalogs Array.<Catalog>

    Array of catalogs

  • options object <optional>

    Options: see CatalogUI

Returns

  • CatalogUI

    Instance of a VisiOmatic catalog interface.

Source

channelUI(optionsopt) → {ChannelUI}

Instantiate a VisiOmatic dialog for managing channels in a VisiOmatic layer.

Parameters

  • options object <optional>

    Options: see ChannelUI

Returns

  • ChannelUI

    Instance of a channel mixing user interface.

Source

coords(optionsopt) → {Coords}

Instantiate a coordinate display/control .

Parameters

  • options object <optional>

    Options: see Coords.

Returns

  • Coords

    Instance of a coordinate display/control interface.

Source

docUI(urlopt, optionsopt) → {DocUI}

Instantiate a VisiOmatic dialog for the online documentation.

Parameters

  • url string <optional>

    Documentation URL.

  • options object <optional>

    Options: see DocUI

Returns

  • DocUI

    Instance of a VisiOmatic documentation user interface.

Source

ellipse(latlng, optionsopt) → {Ellipse}

Instantiate an ellipse marker with a shape that scales with zooming.

Parameters

  • latlng leaflet.LatLng

    World coordinates of the center of the marker.

  • options object <optional>

    Options: see Ellipse.

Returns

  • Ellipse

    Instance of an ellipse marker.

Example

...
   const marker = ellipse(latLng(30.0, 24.0), {
				majAxis: 4.3,
				minAxis: 2.1,
				posAngle: 47.3
	});

Source

ellipseMarker(latlng, optionsopt) → {EllipseMarker}

Instantiate an ellipse marker.

Parameters

  • latlng leaflet.LatLng

    World coordinates of the center of the marker.

  • options object <optional>

    Options: see EllipseMarker.

Returns

  • EllipseMarker

    Instance of an ellipse marker.

Example

...
   const marker = ellipseMarker(latLng(30.0, 24.0), {
				majAxis: 24.7,
				minAxis: 12.1,
				posAngle: 47.3
	});

Source

flipSwitch(parentopt, optionsopt) → {FlipSwitch}

Instantiate a flip switch widget.

Parameters

  • parent object <optional>

    Parent element.

  • options object <optional>

    Options: see FlipSwitch

Returns

  • FlipSwitch

    Flip switch widget element.

Example

...
   const elem = DomUtil.create('div', 'myelement', divParent);
   const flipElem = flipSwitch(elem, {checked: true});

Source

imageUI(optionsopt) → {ImageUI}

Instantiate a VisiOmatic dialog for setting the rendering of a VisiOmatic layer.

Parameters

  • options object <optional>

    Options: see ImageUI

Returns

  • ImageUI

    Instance of a user interface for the rendering preferences.

Source

pixelValues(optionsopt) → {PixelValues}

Instantiate a pixel value display interface.

Parameters

  • options object <optional>

    Options: see Coords.

Returns

  • PixelValues

    Instance of a pixel value display interface.

Source

profileUI(optionsopt) → {ProfileUI}

Instantiate a VisiOmatic dialog for plotting image profiles and spectra.

Parameters

  • options object <optional>

    Options: see ProfileUI

Returns

  • ProfileUI

    Instance of a VisiOmatic profile and spectrum plotting user interface.

Source

regionUI(regionsopt, optionsopt) → {RegionUI}

Instantiate a VisiOmatic dialog for region overlays.

Parameters

  • regions Array.<region> <optional>

    Regions to overlay.

  • options object <optional>

    Options.

Returns

  • RegionUI

    Instance of a VisiOmatic region interface.

Source

rgb(r, g, b) → {RGB}

Instantiate an RGB triplet.

Parameters

  • r number | Array.<number> | string | RGB

    Red value, rgb array, hexadecimalstring representation, or RGB triplet.

  • g number

    Green value.

  • b number

    Blue value.

Returns

  • RGB

    Instance of an RGB triplet.

Example

const color = rgb('#A0B8C4');

Source

scale(optionsopt) → {Scale}

Instantiate a scale bar.

Parameters

  • options object <optional>

    Options: see Scale

Returns

  • Scale

    Instance of a scale bar.

Example

const doubleScale = scale({degrees: true, pixels: true}).addTo(map);

Source

Instantiate a sidebar.

Parameters

  • options object <optional>

    Options: see Sidebar

Returns

  • Sidebar

    Instance of a sidebar.

Example

const sb = sidebar({position: right}).addTo(map);

Source

snapshotUI(optionsopt) → {SnapshotUI}

Instantiate a VisiOmatic dialog for taking snapshots.

Parameters

  • options object <optional>

    Options: see SnapshotUI

Returns

  • SnapshotUI

    Instance of a VisiOmatic snapshot interface.

Source

spinbox(parentopt, optionsopt) → {Spinbox}

Instantiate a spinbox widget.

Parameters

  • parent object <optional>

    Parent element.

  • options object <optional>

    Options: see Spinbox

Returns

  • Spinbox

    Spinbox widget element.

Example

...
   const elem = DomUtil.create('div', 'myelement', divParent);
   const spinElem = Spinbox(elem, {initValue: 42.0, step: 2.0});

Source

vTileLayer(url, optionsopt) → {VTileLayer}

Instantiate a VisiOmatic tile layer.

Parameters

  • url string

    URL of the tile server.

  • options object <optional>

    Options: see VTileLayer.

Returns

  • VTileLayer

    VisiOmatic TileLayer instance.

Source

wcs(header, images, optionsopt) → {WCS}

Instantiate a World Coordinate System.

Parameters

  • header object

    JSON representation of the merged image header.

  • images Array.<Image>

    Array of image extensions.

  • options object <optional>

    Options: see WCS.

Returns

  • WCS

    WCS instance.

Source

Type Definitions

coordinate

Coordinate settings.

Properties

  • type 'world' | 'pixel'

    Coordinate type.

  • label string

    Coordinate name.

  • units 'deg' | 'HMS' | ''

    Coordinate units.

  • celsyscode 'equatorial' | 'ecliptic' | 'galactic' | 'supergalactic'

    Coordinate system.

Source

ellipseShape

Ellipse shape parameters.

Properties

  • majAxis number <optional>

    Length of the ellipse major axis in pixels.

  • minAxis number <optional>

    Length of the ellipse minor axis in pixels.

  • posAngle number <optional>

    Ellipse position angle in degrees (CCW from x axis).

Source

image

Image metadata sent in JSON by the VisiOmatic server.

Properties

  • size Array.<number>

    Shape of the image (FITS convention: NAXIS1 first).

  • dataslice Array.<Array.<number>>

    Start index, end index, and direction (+1 only) of the used section of the image data for each axis. The range notation follows the FITS convention (start at index 1 and include the end index).

  • detslice Array.<Array.<number>>

    Start index, end index, and direction (+1 or -1) of the used section of the detector in the merged image for each axis. The range notation follows the FITS convention (start at index 1 and include the end index).

  • min_max Array.<Array.<number>>

    Minimum and maximum clipping limits of the pixel values on each image plane.

  • header object

    JSON representation of the merged image header.

Source

projParam

Projection parameters. The ordering of array elements follows the Leaflet convention: latitude comes first in [latitude,longitude] pairs, while x comes first in Cartesian coordinates. However the center of the first pixel in the array has image coordinates [1.0, 1.0], conforming to the FITS convention. Private properties are set by methods. Other private properties may be added by subclass methods.

Properties

  • name string

    Extension name.

  • ctype Object

    Projection coordinate types (CTYPEi FITS keyword values).

  • naxis Array.<number>

    Image shape (NAXISi FITS keyword values)

  • crpix Array.<number>

    (CRPIXi FITS keyword values). Image coordinates of the projection center.

  • crval Array.<number>

    Celestial latitude and longitude of the projection center. (CRVALi FITS keyword values).

  • cd Array.<Array.<number>>

    Jacobian matrix of the deprojection (CDi_j FITS keyword values).

  • natpole Array.<number>

    Latitude and longitude of the native pole.

  • pv Array.<Array.<number>>

    Projection distortion terms on each axis (PVi_j FITS keyword values).

  • npv number

    Number of non-zero

  • jd Array.<number>

    Julian Date for start and end of observation.

  • obslatlng Array.<number>

    Latitude and longitude of observatory.

  • dataslice Array.<Array.<number>>

    Start index, end index, and direction (+1 only) of the used section of the image data for each axis. The range notation follows the FITS convention (start at index 1 and include the end index).

  • detslice Array.<Array.<number>>

    Start index, end index, and direction (+1 or -1) of the used section of the detector in the merged image for each axis. The range notation follows the FITS convention (start at index 1 and include the end index).

  • _cdinv Array.<Array.<number>>

    Jacobian matrix of the projection (inverse of the CD matrix).

  • _natrval Array.<number>

    Native latitude and longitude of the projection center.

  • _pixelFlag boolean

    True for a Cartesian projection.

  • celsyscode 'equatorial' | 'galactic' | 'ecliptic' | 'supergalactic'

    Type of celestial system.

See

Source

rectangleOptions

"Rectangle" footprint options.

Properties

  • color string

    Rectangle color.

  • weight number

    Rectangle line weight.

  • opacity number <optional>
     1

    Rectangle line opacity.

  • fillOpacity number <optional>
     1

    Rectangle fill opacity.

  • clickable boolean <optional>
     false

    Is the rectangle footprint clickable?

Source

region

Region object.

Properties

  • url string

    URL for accessing the GeoJSON data.

  • name string

    Name of the region (as it will appear in the selection menu of the interface).

  • description string <optional>

    Description of the region (as it will appear in a popup marker on the overlay).

  • index number

    Position in the selection menu.

  • color RGB <optional>

    Default color of the region (as it will appear on the overlay).

  • load boolean

    Is the region loaded yet?

  • drawPoint RegionUI~drawCallback <optional>

    Callback function for custom drawing of a GeoJSON point feature.

Source

valueSettings

Pixel value settings.

Properties

  • type 'raw' | 'sbmag'

    Value type.

  • label string

    Value name.

  • units 'ADU' | 'mag.arcsec⁻²'

    Value units.

  • mag boolean

    Result in magnitude?

  • subtract boolean

    Subtract background?

Source