Camera Alert ( antares.alert.CameraAlert )

class antares.alert.CameraAlert(alert_id, ra, decl, CA, decision, locus_id, IM=None, IR=None, IS=None)

Bases: antares.alert.Alert

Represents a camera alert which is a sub-class of Alert. A camera alert is associated with CA, IM, IR, IS and LA context objects. and is initialized with these 5 available contexts.

Param:int alert_id: The unique ID of this Camera Alert. Param:float ra: The right ascension of the Camera Alert’s observation, in degrees. Param:float decl: The declination of the Camera Alert’s observation, in degrees. Param:antares.context.CAContext CA: The CAContext which this Camera Alert contains. Param:int decision: The decision whether to divert, mark as rare, or undecided. Param:int locus_id: The ID of the locus to which this Camera Alert belongs. Param:antares.context.IMContext IM: The IMContext which this Camera Alert has. Param:antares.context.IRContext IR: The IRContext which this Camera Alert has. Param:antares.context.ISContext IS: The ISContext which this Camera Alert has.

Attributes Summary

CA	CA (Camera Alert) context object.
LA	LA (Locus-aggregated Alert) context object that contains this alert.
IM	IM (Image) context object that this alert is in.
IR	IR (Image RAFT) context object that this alert is in.
IS	IS (Image Section) context object that this alert is in.
replicas	A list of the alert replicas created by camera alert.
combos	A list of the alert combos created by camera alert.
annotation	The annotation notes the cause for diverting or marking as rare.

Methods Summary

createReplica([astro_id])	Create an alert replica which is associated with an optional astro object id astro_id.
createCombo(replicas)	Create an alert combo object which contains a set of alert replicas.
numReplicas()	Check how many replicas a Camera Alert has.
throttle(annotation)	Throttle the alert.
divert(annotation)	Divert the alert.
mark_as_rare(annotation)	Mark the alert as a rare alert.

Attributes Documentation

CA = None

CA (Camera Alert) context object. CA propibutes are always available. The Camera Alert contains its CAContext.

Type:antares.context.CAContext

LA = None

LA (Locus-aggregated Alert) context object that contains this alert. LA propibutes are always available. The LAContext contains this CameraAlert.

Type:antares.context.LAContext

IM = None

IM (Image) context object that this alert is in. The CameraAlert has the IMContext.

Type:antares.context.IMContext

IR = None

IR (Image RAFT) context object that this alert is in. The CameraAlert has the IRContext.

Type:antares.context.IRContext

IS = None

IS (Image Section) context object that this alert is in. The CameraAlert has the ISContext.

Type:antares.context.ISContext

replicas = None

A list of the alert replicas created by camera alert. The Camera Alert contains these Replicas.

Type:list

combos = None

A list of the alert combos created by camera alert. The Camera Alert contains these Combos.

Type:list

annotation

The annotation notes the cause for diverting or marking as rare.

Type:string

Methods Documentation

throttle(annotation)

Throttle the alert.

Parameters:annotation (string) – a short description of why the alert is throttled.

divert(annotation)

Divert the alert.

Parameters:annotation (string) – a short description of why the alert is diverted.

createReplica(astro_id=None)

Create an alert replica which is associated with an optional astro object id astro_id.

Param:int astro_id: ID of the astro object to be associated with the created replica. It is optional.

createCombo(replicas)

Create an alert combo object which contains a set of alert replicas.

Parameters:replicas (list) – a list of alert replicas

numReplicas()

Check how many replicas a Camera Alert has.

Returns:The number of replicas generated from this alert.

mark_as_rare(annotation)

Mark the alert as a rare alert.

Parameters:annotation (string) – a short description of why the alert is rare.