|
ANY-maze Help > The ANY-maze reference > The Tests page > The Experiment management reports > The Test data report > Data that can be included in the Test data report
Data that can be included in the Test data report
Test control
Animal position and activity
Zone data
Point data
Sequence data
Key data
On/off input data
On/off input index sequence
Rotary encoder data
Movement detector data
Signal data
Sensor data
On/off output data
Speaker data
Pellet dispenser data
Light controller data
Syringe pump data
Shocker data
Laser controller data
Virtual switch data
Event data
Result variable data
Plug-in data
Test control
Test start
| Description | Occurs when the test stars |
| Units | This is an instantaneous value. 1 means test start. |
| Notes | This will always be timed at 0:00 |
Pause on
| Description | Occurs whenever the test is paused, whether it is paused by the user clicking the pause button, or paused by a procedure using a 'Pause test' action. |
| Units | This is a state value. 1 means pause is on, 0 means pause is not on. |
| Notes | When a test is paused the test clock stops - this means any Pause on will be timed at the same time as the corresponding Pause off. |
Pause off
| Description | Occurs whenever the test is unpaused, whether it is unpaused by the user clicking the pause or start button, or unpaused by a procedure using a 'Unpause test' action. |
| Units | This is a state value. 1 means pause is off, 0 mean pause is not off. |
| Notes | When a test is paused the test clock stops - this means any Pause off will be timed at the same time as the corresponding Pause on. |
Test end
| Description | Occurs when the test ends |
| Units | This is an instantaneous value. 1 means test end. |
Tracking analysis result
| Description | ANY-maze will try to track the animal in every image it receives from the camera. However, it may not always succeed - for example, if there are two potential 'animals' in the image then ANY-maze will not track either of them. |
Possible values shown here include:
| | OK | The image was successfully analysed |
| | MAXSIZE | The potential 'animal' in the image is larger than the maximum size ANY-maze expects the animal to have. |
| | NOBLOB | There is nothing in the image that ANY-maze thinks could be the animal. |
| | HIDDEN | The animal is hidden. |
| | RESET | The tracking system was reset - this can occur during a test. ANY-maze will usually start tracking again. |
| | TRACKING_SWITCHOFF | ANY-maze is not tracking |
| | BKGND_FRAME_UNDEFD | ANY-maze does not have a background image to compare to the image from the camera. |
| | LIGHTING_CHANGE | ANY-maze has detected an overall change in lighting in the image (the whole image has become lighter or darker). |
| | FRAME_BEFORE_START | The image was captured before the start of the test |
| | FAIL_CALCBLOBINFO | ANY-maze was unable to analyse the potential 'animal' in the image. |
| | NO_RECENTBLOB_DATA | ANY-maze has not yet analysed enough images to determine what in image might be an animal. This is always the case at the start of a test. |
| | MORE_THAN_3_BLOBS | There are more than three things in the image that ANY-maze thinks could potentially be the 'animal'. |
| | TWO_SIMILAR_BLOBS | There are two things in the image that ANY-maze thinks could potentially be the 'animal' and they are very similar. |
| | BELOW_TARGET_SCORE | The thing in the image that ANY-maze thinks could potentially be the 'animal' is too different to the previous 'animals' it has tracked. |
| | FAIL_TARGET_DETECT | ANY-maze was unable to automatically determine whether the animal is lighter or darker than the image background. |
| | ERROR | An internal error occurred. |
| Notes | This value is only available if the recording of tracking analysis results has been switched on in Advanced support. We don't recommend switching this on unless advised to do so by ANY-maze support. |
Frame number (within the test's results)
| Description | A sequential number given to the frames (i.e., pictures from the video source) that cause an entry to be stored in the test's results. |
The frame number column is useful when the Test data spreadsheet includes both tracking and non-tracking data (such as data read from an I/O device or data generated by keys). In these cases, the non-tracking data will not be synchronised with the frames from the camera, which can make it hard to differentiate the tracking from the non-tracking data (which can be important when synchronising with data from other systems). For example, in the Test data spreadsheet in the figure below the animal was at position 420,113 at time 6.032s and remained in this location until 6.297s. While it was there it started grooming at time 6.152s.
Figure 1. Extract from a Test data spreadsheet showing Frame numbers.
The frame number makes it possible to differentiate the data which relates to the animal's position from the data relating to grooming: Frame 47 is timed at 6.032s and frame 48 is timed at 6.172s; at time 6.152s when grooming started, the frame was still 47, indicating that no new position was received at this time. You might think that any row showing that a key (or I/O) has become active would necessarily mean that no new frame was received at that time, but while this will often be true, it will not always be the case, as the key or I/O data might be timed at exactly the same moment as a new position is received. Had this been the case in the test shown in the above figure then the frame number at time 6.152s would have been 48, and not 47.
The frame number reported here is usually not the same as the frame number of the frames provided by the camera. For example, a camera may be providing 30 frames (images) per second, but ANY-maze might be set to only record a maximum of perhaps 10 positions per second - in this case the 'Frame number' reported will apply to the 10 frames recorded each second and not to the 30 frames being provided by the camera. In fact, in this example, ANY-maze will record a maximum of 10 frames per second, so it might actually record fewer frames than this, perhaps 8 - in any case, it is these recorded frames that will be given sequential numbers.
Even if ANY-maze is set to record every position of the animal (and frames in which the animal was not tracked), the frame numbers still may not be the same as the camera's frame numbers, as frame might be 'dropped', which can happen when it takes longer to process one frame than the inter-frame interval.
Animal position and activity
The position of the animal
| Description | The x, y coordinates of the centre of the animal (the orange tracking marker). The coordinates are relative to the top-left of the video source. |
| Notes | When ANY-maze doesn't know where the animal's centre is, the x and y coordinates will be reported as #N/A. |
In general the absolute coordinates are not very useful, however the relative coordinates represent the movement of the animal's centre.
If you calculate the difference between all the coordinates and sum them you will determine the total distance that the centre MOVED during the test. This will probably NOT agree with the Total distance travelled reported by ANY-maze. This is because ANY-maze excludes small oscillations from the animal's track. For example, if an animal sits in one place grooming, then the centre will probably repeatedly move a few pixels from side to side, but ANY-maze will not report this as Distance travelled, however, summing the differences between the x,y coordinates would include it.
The position of the animal's head
| Description | The x, y coordinates of the animal's head (the green tracking marker). |
| Notes | When ANY-maze doesn't know where the animal's head is, the x and y coordinates will be reported as #N/A. Note that sometimes ANY-maze will track the centre but fail to track the head, in which case the centre coordinates will be shown but the head coordinates will be #N/A. |
In general the absolute coordinates are not very useful, however the relative coordinates represent the movement of the animal's head.
The position of the animal's tail
| Description | The x, y coordinates of the animal's tail (the yellow tracking marker). |
| Notes | When ANY-maze doesn't know where the animal's tail is, the x and y coordinates will be reported as #N/A. Note that sometimes ANY-maze will track the centre but fail to track the tail, in which case the centre coordinates will be shown but the tail coordinates will be #N/A. |
The animal becomes hidden
| Description | Occurs whenever the animal becomes hidden. |
| Units | This is a state value. 1 means the animal is hidden, 0 mean the animal is not hidden. |
The animal becomes visible
| Description | Occurs whenever the animal becomes visible after being hidden. |
| Units | This is a state value. 1 means the animal is visible, 0 mean the animal is not visible, i.e. it is hidden. |
The animal's speed
| Description | The instantaneous speed of the animal. |
| Notes | The animal's instantaneous speed is calculated based on every position of the animal that is stored, with the speed to move from one stored position to the next averaged over the last half a second to generate the final 'instantaneous' speed value. |
The animal becomes mobile
| Description | Occurs when the animal becomes mobile (after being) immobile |
| Units | This is a state value. 1 means the animal is mobile, 0 mean the animal is not mobile, i.e. it is immobile. |
The animal becomes immobile
| Description | Occurs when the animal becomes immobile |
| Units | This is a state value. 1 means the animal is immobile, 0 mean the animal is mobile. |
The animal is active
| Description | Occurs whenever the animal becomes active. The definition of active depends on the settings in the protocol. An animal is considered to be active if it is mobile, or if any key which has been classified as counting as activity is active (i.e. pressed). |
| Units | This is a state value. 1 means the animal is active, 0 mean the animal is not active. |
The animal's freezing score (old value, pre version 7)
| Description | The freezing score that ANY-maze generated during the test. A lower score means the animal is moving less. Scores are affected by the size of the animal in relation to the size of the apparatus. |
The animal's freezing score (new value, post version 7)
| Description | The freezing score that ANY-maze generated during the test. A lower score means the animal is moving less. |
The animal freezes
| Description | Occurs when the animal freezes |
| Units | This is a state value. 1 means the animal is freezing, 0 mean the animal is not freezing. |
| Notes | ANY-maze detects that an animal is freezing a little while after freezing actually begins. (You specify how long this is as part of the freezing parameters in the protocol). Nevertheless, the start of an episode of freezing is recorded as occurring at the time it began and not at the time it was detected it. For example, imagine an animal began to freeze at time 10s; at time 10.5s ANY-maze determines that the animal is freezing (because it has remained freezing for 0.5s); the start of the freezing is recorded as occurring at 10s. |
The animal stops freezing
| Description | Occurs when the animal stops freezing - i.e. it moves |
| Units | This is a state value. 1 means the animal is not freezing, 0 mean the animal is freezing. |
| Notes | Unlike the onset of freezing (see note in previous item) ANY-maze detects the end of freezing almost immediately that it occurs. |
The length of the animal
| Description | The length of the animal as determined from the area that ANY-maze considers to be the animal in the image |
The relative length of the animal (relative to its average length)
| Description | The average length of the animal throughout the test is determined. It's relative length is then calculated as 'length at this moment in time' / 'average length'. Thus a value of 0.9 means the animal is a little 'shorter' than usual, whereas a value of 1.2 would mean it is longer, perhaps it is stretching. |
Amount the animal's body has rotated by
| Description | The amount by which the animal's body has rotated compared to its position in the previous image (in which the head was tracked). |
| Notes | This is only reported if Advanced rotation analysis is switched on the protocol (it can be switched on after tests have been performed). Exactly how a rotations are calculated is defined by these settings. |
Clockwise rotations of the animal's body
| Description | Occurs when the animal completes a clockwise rotation of its body. |
| Units | This is a state value. 1 means the animal has completed a clockwise rotation. |
| Notes | The way in which rotations are determined is described in detail here. |
Anti-clockwise rotations of the animal's body
| Description | Occurs when the animal completes an anti-clockwise rotation of its body. |
| Units | This is a state value. 1 means the animal has completed an anti-clockwise rotation. |
| Notes | The way in which rotations are determined is described in detail here. |
Partial clockwise rotations of the animal's body
| Description | Occurs when the animal completes a partial clockwise rotation of its body but didn't complete an entire rotation. |
| Units | This is a state value. 1 means the animal has completed a partial clockwise rotation. |
| Notes | Partial rotations are defined in the protocol, you'll find more information here. |
Partial anti-clockwise rotations of the animal's body
| Description | Occurs when the animal completes a partial anti-clockwise rotation of its body but didn't complete an entire rotation. |
| Units | This is a state value. 1 means the animal has completed a partial anti-clockwise rotation. |
| Notes | Partial rotations are defined in the protocol, you'll find more information here. |
The animal's turn angle (based on the position of its centre point)
| Description | The amount the animal's vector of movement has altered from the previous position to this one. For example if the animal starts in the centre of an open field and the next position has it north of its starting position, then its vector of movement is northwards. If the next position is directly west of the previous position then its new vector of movement is westwards; the turn angle between these positions would be 90°. |
When calculating turn angle, a position is only considered to be the 'next' position, if it is more than a minimum distance from the previous position - with this minimum being based on the size of the animal. This avoids reporting spurious turn angles for very small movements.
| Notes | Turns to the right are reported as negative values, turns to the left are reported as positive values. |
Orientation of the animal's head
| Description | The orientation of the animal's head, in other words the direction the animal is facing. Zero degrees is vertically up in the video picture with the angle increasing in a clockwise direction. This is the same as a compass, i.e. 0° is vertically up in the video picture (North), 90° is to the right of the video picture (East), 180° is down in the video picture (South) and 270° is to the left of the video picture (West). |
| Notes | The orientation is only reported when the position of the animal's head was determined. The orientation is determined by drawing a vector from the 'start head vector position' to the head position. In most cases the 'start head vector position' is the centre of the animal, however, when tracking Quail, this is the 'start head vector position' determined by the tracking system which approximates to the position of the base of the animal's neck. |
The strategy currently being used by the animal
| Description | The name of the strategy that the strategy analysis has concluded the animal is currently using. This will depend on the exact strategy analysis being employed. |
List of the zones the animal is in
| Description | A comma separated list of all the zones that the animal is currently in. As zones are not mutually exclusive, the animal can be in more than one zone at once. |
| Notes | Only available when the protocol includes at least one zone. |
Zone data
Entries into the zone
| Description | Occurs when the animal enters a zone. |
| Units | This is a state value. 1 means the animal is in the zone. 0 means the animal is not in the zone. |
Exits from the zone
| Description | Occurs when the animal exits a zone. |
| Units | This is a state value. 1 means the animal is not in the zone. 0 means the animal is in the zone. |
Partial exit from the zone
| Description | Occurs when the animal makes a partial exit from a hidden zone. |
| Units | This is a state value. 1 means the animal is partially exited from the zone. 0 means the animal is not partially exit from the zone |
| Notes | What counts as a partial exit from a hidden zone depends on the settings made under the Partial exits section of the zone's entry and exit settings. |
Distance of the animal from the zone (when outside)
| Description | The distance of from the animal to the zone. Exactly how ANY-maze measures this distance depends on whether zone entries (sic) are set to use the entire area of the animal or the animal's centre point (see Choosing how ANY-maze should detect entries into a zone for details). If entries are based on the entire area of the animal, then the calculation of the distance from the animal to the zone will also be based on the entire area of the animal - specifically, the system will use the distance from the point on the animal's edge that is closest to the zone border; on the other hand if zone entries are based on the centre of the animal, then the distance to the zone will also be based on the centre of the animal - i.e. the distance to the zone will simply be the distance from the centre to the nearest part of the zone. |
| Notes | When the animal is inside the zone, the distance to the zone is reported as 0. |
Distance of the animal from the zone border (when inside)
| Description | Distance from the animal to the border of the zone when the animal is inside the zone. Exactly how ANY-maze measures this distance depends on whether zone entries (sic) are set to use the entire area of the animal or the animal's centre point (see Choosing how ANY-maze should detect entries into a zone for details). If entries are based on the entire area of the animal, then the calculation of the distance from the animal to the zone border will also be based on the entire area of the animal - specifically, the system will use the distance from the point on the animal's edge that is closest to the zone border; on the other hand, if zone entries are based on the centre of the animal then the distance to the zone border will also be based on the centre of the animal - i.e. the distance to the zone will simply be the distance from the centre to the nearest border of the zone. |
| Notes | When the animal is outside the zone the distance to the border is reported as #N/A. |
Distance of the animal's head from the zone (when outside)
| Description | Distance of the animal's head to the closest point of the zone. |
| Notes | When the animal's head is inside the zone the distance to the zone is reported as 0. |
Distance of the animal's head from the zone border (when inside)
| Description | Distance from the animal's head to the closest point on the border of the zone when the animal is inside the zone. |
| Notes | When the animal's head is outside the zone the distance to the zone border is reported as #N/A. |
Heading error to the zone
| Description | The angle between the animal's heading and a direct heading to the zone. |
To determine the animal's heading a vector is created from the animal's previous position to its current position, this defines its heading.
The way the direct heading to the zone is calculated depends on the settings in the Analysis options > Heading error sub-element of the protocol. Specifically, if the centre of the zone is used then a second vector is created from the animal's position to the centre of the zone - the heading error is the angle between the this vector and the animal's heading vector.
The other option is to use the entire zone (rather than its centre). In this case ANY-maze considers the heading to every position on the zone's perimeter - with, the heading error being the smallest angle between the animal's heading and the heading to any perimeter point.
Investigating the zone
| Description | Occurs when the animal starts investigating the zone. Exactly what constitutes investigation depends on how the zone has been set up. |
| Units | This is a state value. 1 means the animal is investigating the zone. 0 means the animal is not investigating the zone. |
Not investigating the zone
| Description | Occurs when the animal stops investigating the zone. Exactly what constitutes investigation depends on how the zone has been set up. |
| Units | This is a state value. 1 means the animal is not investigating the zone. 0 means the animal is investigating the zone. |
Oriented towards the zone
| Description | The angle the between animal's orientation vector (see notes) and a vector from the animal's head to the zone's perimeter is calculated, if this is less than or equal to half the Orientation angles defined in the protocol, then the animal is oriented towards the point. |
| Units | This is a state value. 1 means the animal is oriented towards the point. 0 means the animal is not oriented towards the point. |
| Notes | The animal's orientation is defined by a vector connecting the start of the head vector position to the head position. For most animals, excluding quails, the start of the head vector position is the animal's centre. However, in the case of quails, it is a point near the base of the neck, which was determined during tracking. |
Orientation of the animal relative to the zone
| Description | The smallest angle between the animal's orientation vector (see notes) and a vector from the animal's head position to a point on the zone's perimeter. The angle is reported as a signed value from -180° to 180°, with positive values indicating that the zone is to the left of the animal's orientation vector. |
| Notes | The animal's orientation is defined by a vector connecting the start of the head vector position to the head position. For most animals, excluding quails, the start of the head vector position is the animal's centre. However, in the case of quails, it is a point near the base of the neck, which was determined during tracking. |
Point data
Distance of the animal from the point
| Description | The distance from the animal to the point. The method actually used to calculate this distance depends on the setting made when setting up the point. Specifically, the distance can either be calculated based on the part of the animal (excluding its tail) which is closest to the point, or based on the position of the centre of the animal. |
Distance of the animal's head from the point
| Description | The distance from the animal's head position to the point. |
Heading error to the point
| Description | Angle between a vector from the animal's position to the point and a second vector from the animal's previous position to its current position (i.e. its heading). |
Oriented towards the point
| Description | The angle the between animal's orientation vector (see notes) and a vector from the animal's head to the point is calculated, if this is less than equal to half the Orientation angles defined in the protocol, then the animal is oriented towards the point. |
| Units | This is a state value. 1 means the animal is oriented towards the point. 0 means the animal is not oriented towards the point. |
| Notes | The animal's orientation is defined by a vector connecting the start of the head vector position to the head position. For most animals, excluding quails, the start of the head vector position is the animal's centre. However, in the case of quails, it is a point near the base of the neck, which was determined during tracking. |
Orientation of the animal relative to the point
| Description | The angle the between animal's orientation vector (see notes) and a vector from the animal's head to the point. The angle is reported as a signed value from -180° to 180°, with positive values indicating that the point is to the left of the animal's orientation vector. |
| Notes | The animal's orientation is defined by a vector connecting the start of the head vector position to the head position. For most animals, excluding quails, the start of the head vector position is the animal's centre. However, in the case of quails, it is a point near the base of the neck, which was determined during tracking. |
Sequence data
Sequence start (may be broken)
| Description | Occurs when the animal enters the zone or area that starts a potential sequence. If the sequence is completed then the sequence completion will be reported before any other sequence start. |
| Units | This is an instantaneous value. 1 means the animal has started the sequence. |
Sequence completion
| Description | Occurs when the animal enters the zone or area that ends a sequence. |
| Units | This is an instantaneous value. 1 means the animal has completed the sequence. |
Key data
Key activation
| Description | Occurs when a key is activated, i.e. when the key is pressed |
| Units | This is a state value. 1 means the key is active. O means the key is not active. |
Key deactivation
| Description | Occurs when a key is deactivated - exactly what causes a key to be deactivated depends on the key's type. |
| Units | This is a state value. 1 means the key is not active. O means the key is active. |
On/off input data
Input activation
| Description | Occurs when an on/off input is activated. |
| Units | This is a state value. 1 means the input is active. O means the input is not active. |
Input deactivation
| Description | Occurs when an on/off input is deactivated. |
| Units | This is a state value. 1 means the input is not active. O means the input is active. |
On/off input index sequence
Sequence of on/off input index activations
| Description | Reports the ordinal number of the most recently activated on/off input (for which an ordinal value has been specified). |
| Notes | It's important to understand that the ordinal number reported only changes when another on/off input (for which an ordinal value has been specified) is activated. For example, if the inputs are photobeams in a corridor and are numbered 1 to 4 then as the animal walks up the corridor it will break beam 1, activating it. The ordinal value reported her will therefore be 1. It then passes beam 1 so the beam is deactivated, but the ordinal value reported will still be 1. It then breaks beam 2, activating it. At this point, the ordinal value reported will be 2. |
A positive reversal
| Description | Occurs when the sequence of on/off input ordinal values changes from a decreasing series of values to an increasing one. In the example give above, this would occur if the animal was walking down the corridor in a direction that meant that beams 4, 3, 2 we being broken and then it changed direction and broke beam 3 again. |
| Units | The is an instantaneous value. 1 means a positive reversal has occurred. |
A negative reversal
| Description | Occurs when the sequence of on/off input ordinal values changes from an increasing series of values to an decreasing one. In the example give above, this would occur if the animal was walking down the corridor in a direction that meant that beams 1, 2, 3 we being broken and then it changed direction and broke beam 2 again. |
| Units | The is an instantaneous value. 1 means a negative reversal has occurred. |
Rotary encoder data
Clockwise pulses of the encoder
| Description | Occurs when the encoder outputs a single clockwise pulse. |
| Units | This is an instantaneous value. A 1 means a clockwise pulse has occurred. |
| Notes | The number of pulses an encoder outputs for each rotation depends on the encoder and should be provided in the encoders documentation. Pulses are evenly spaced through a rotation, so for example, an encoder which outputs 60 pulses per rotation, outputs 1 pulse as the rotating encoder passes each multiple of 6°. |
Anti-clockwise pulses of the encoder
| Description | Occurs when the encoder outputs a single anti-clockwise pulse. |
| Units | This is an instantaneous value. A 1 means an anti-clockwise pulse has occurred. |
| Notes | The number of pulses an encoder outputs for each rotation depends on the encoder and should be provided in the encoders documentation. Pulses are evenly spaced through a rotation, so for example, an encoder which outputs 60 pulses per rotation, outputs 1 pulse as the rotating encoder passes each multiple of 6°. |
Speed of the encoders (RPM)
| Description | The instantaneous rotational speed of the encoder. This is based on the averaged frequency with which pulses are being reported. |
Clockwise rotation of the encoder
| Description | Occurs when the encoder completes an entire clockwise rotation. |
| Units | This is an instantaneous value. A 1 means a clockwise rotation has occurred. |
| Notes | Partial reversals of the encoder are ignored. For example, imagine the encoder is attached to the hour hand of a clock. The clock starts at 12 and then rotates clockwise to 7, it then reverses direction and goes back to 4, before reversing direction again and continuing to rotate clockwise to 12. When it reaches 12 a clockwise rotation will be reported. |
Anti-clockwise rotation of the encoder
| Description | Occurs when the encoder completes an entire anti-clockwise rotation. |
| Units | This is an instantaneous value. A 1 means an anti-clockwise rotation has occurred. |
| Notes | Partial reversals of the encoder are ignored. For example, imagine the encoder is attached to the hour hand of a clock. The clock starts at 12 and then rotates anti-clockwise to 3, it then reverses direction and goes back to 7, before reversing direction again and continuing to rotate anti-clockwise to 12. When it reaches 12 an anti-clockwise rotation will be reported. |
Movement detector data
Beam break
| Description | Occurs when a beam in the movement detector is broken |
| Units | This is an instantaneous value. A 1 means the beam has been broken. |
Animal is moving
| Description | Occurs when an animal is detected as moving by the movement detector. A movement detector will consider the animal is moving for the timeout duration specified in the protocol after each beam break. For example, if the timeout is 0.5s then if the animal breaks beams at times: 1.0s, 1.2s, 1.5s, 2.6s, 2.8s; then the movement detector will report that the animal is moving from time 1.0s to 2.0s (timeout after the break at 1.5s) and from time 2.6s to 3.3s. |
| Units | This is a state value. 1 means the animal is moving. 0 means it is not moving |
Signal data
The signal's value
| Description | The signal's value with any conversion specified in the protocol applied to it. |
| Units | Units specified in the protocol |
Sensor data
The sensor's value
| Description | The value reported by the sensor. |
| Units | Depends on the sensor type: |
| | Humidity | Percent (relative humidity) |
On/off output data
On/off output activation
| Description | Occurs when an on/off output is activated. |
| Units | This is a state value. 1 means the output is active. 0 means the output is not active. |
| Notes | Making an on/off output active means it will change the physical output to whatever active state was set in the protocol. For example, this might mean the output starts to output a pulse train, or might even mean it switches off (if it set to 'Turn off' when activated). |
On/off output deactivation
| Description | Occurs when an on/off output is deactivated. |
| Units | This is a state value. 1 means the output is not active. 0 means the output is active. |
Speaker data
Speaker activation
| Description | Occurs when a speaker is activated, i.e. it is playing. |
| Units | This is a state value. 1 means the speaker is active. 0 means the speaker is not active. |
| Notes | A speaker which is set to play at a volume of zero is not considered to be active. |
Speaker volume
| Description | The volume the speaker is set to play at |
| Units | Percent, where 100% is simply the loudest the speaker can play. |
| Notes | There is an explanation as to why the volume is not reported in decibels here. |
Pellet dispenser data
Pellet dispensed
| Description | Occurs when a pellet is dispensed |
| Units | This is an instantaneous value. 1 means a pellet has been dispensed. |
| Notes | If the pellet dispenser provides feedback indicating successful dispensing of a pellet then this WILL reflect that (i.e. a value of 1 means a pellet really was dispensed). However, many pellet dispensers do not provide feedback, in which case this simply reflects the fact that the pellet dispenser was instructed to dispense a pellet, however a pellet may not actually have been dispensed if, for example, the hopper is empty. |
Light controller data
Light controller activation
| Description | Occurs when a light controller is activated, i.e. the light is switched on. |
| Units | This is a state value. 1 means the light controller is active. 0 means the light controller is inactive. |
| Notes | The minimum level a light controller can be set to is 1%, so even if a controller is activated at a level of 1% (which might actually be so dim as to appear off) it is still considered to be active. |
Light controller level
| Description | The light level of the light controller. |
| Units | Percent, where 100% is as bright as the light can be. |
| Notes | The minimum light level is 1%. |
Syringe pump data
Pump is running
| Description | Occurs when the syringe pump starts running |
| Units | This is a state value. 1 means the pump is running. 0 means the pump is stopped. |
| Notes | The pump is considered to be running irrespective of the direction (infuse or withdraw). If the pump stalls (reaches the end of its travel) then it will stop running. |
Volume infused
| Description | The volume that the pump has infused |
| Notes | If the volume infused is reset then the volume reported will start from zero again. |
Volume withdrawn
| Description | The volume that the pump has withdrawn |
| Notes | If the volume infused is reset then the volume reported will start from zero again. |
Shocker data
Shocker activation
| Description | Occurs when the shocker is activated. |
| Units | This is a state value. 1 means the shocker is applying a shock. 0 means the shocker is not applying a shock. |
Shock current
| Description | The current the shocker is delivering. |
| Notes | The shock current is only reported while the shocker is active. |
Laser controller data
Laser controller activation
| Description | Occurs when the laser controller becomes active |
| Units | This is a state value. 1 means the laser controller is active. 0 means the laser controller is inactive. |
Laser controller deactivation
| Description | Occurs when the laser controller becomes inactive |
| Units | This is a state value. 1 means the laser controller is inactive. 0 means the laser controller is active. |
Laser controller intensity
| Description | The intensity of the laser controller, where a value of 0V mean the laser is actually off, and a value of 5V means the laser is at its maximum intensity. |
| Notes | The intensity is only reported when the laser controller is active. |
Virtual switch data
Virtual switch activation
| Description | Occurs when the virtual switch becomes active |
| Units | This is a state value. 1 means the virtual switch is active. 0 means the virtual switch is inactive. |
| Notes | Full details about virtual switches can be found here. |
Virtual switch deactivation
| Description | Occurs when the virtual switch becomes inactive |
| Units | This is a state value. 1 means the virtual switch is inactive. 0 means the virtual switch is active. |
| Notes | Full details about virtual switches can be found here. |
Event data (deprecated)
Event occurs
| Description | Occurs when an Event occurs (see notes) |
| Units | This is an instantaneous value and is a 1 when the event occurs |
| Notes | The events being referred to here are the old 'Events' for the 'Events and Actions' system using in ANY-maze prior to version 5.0. |
Result variable data
Result variable value
| Description | The value of a result variable stored by a procedure |
| Units | This is an instantaneous value and is the value of the variable at the moment it was stored |
| Notes | Full details about procedure result variables can be found here. |
Plug-in data
Plug-in activation
| Description | Occurs when an action plug-in is been activated |
| Units | This is a state value. 1 means the plug-in is active. 0 means the plug-in is inactive. |
| Notes | Full details about action plug-ins can be found here. |
Plug-in deactivation
| Description | Occurs when an action plug-in is been deactivated |
| Units | This is a state value. 1 means the plug-in is inactive. 0 means the plug-in is active. |
| Notes | Full details about action plug-ins can be found here. |
The value reported by the plug-in
| Description | The value returned from a plug-in as a result |
| Units | Depends on the plug-in |
| Notes | Full details about the results that a plug-in can store can be found here. |
© Copyright 2003-2026 Stoelting Co. All rights reserved
ANY-maze help topic T1396
|