System-defined Properties
System-defined properties describe an object’s identity, structure, or computed
attributes. Their names begin with _. Some, such as _uniqueid, apply to
all objects; others, such as _label, belong to particular object types.
Projected nodes include _class. Connections additionally include
_src_type, _src_class, _dst_type and _dst_class. These category
fields are output only; use command selectors to filter categories. They are
rejected in property writes, input expressions, sorting, grouping and indexes.
Descriptor-set properties are removed: vector configuration and customer
metadata are returned by GetIndexes.
These properties are maintained by ApertureDB. An Update command can change a system-defined property only through a parameter that explicitly supports it. The table lists each property, its update parameter where available, and whether it can appear in constraints:
Object |
Properties |
Type |
Param for Update Command |
Can Be Used in constraints |
Notes |
|---|---|---|---|---|---|
All Objects |
_uniqueid |
string |
Y |
Unique id for the object |
|
_create_txn |
number |
Y |
Transaction id that created the object |
||
Connection |
_src |
string |
N |
unique_id of the src of the connection |
|
_dst |
string |
N |
unique_id of the dst of the connection |
||
Descriptor |
_label |
string |
Y |
||
BoundingBox |
_label |
string |
Y |
||
_coordinates |
rect |
N |
|||
_area |
number |
Y |
Area (in pixels) of the BoundingBox |
||
Polygon |
_label |
string |
Y |
||
_vertices |
poly |
N |
|||
_area |
number |
Y |
Area (in pixels) of the Polygon |
||
_bounds |
rect |
N |
The smallest rectangle containing the Polygon |
||
Video |
_fps |
number |
Y |
Average frames per second |
|
_frame_count |
number |
Y |
Number of frames in the video |
||
_frame_width |
number |
Y |
Width of the frame |
||
_frame_height |
number |
Y |
Height of the frame |
||
Frame |
_label |
string |
Y |
||
_frame_number |
number |
Y |
|||
_time_offset |
string |
Y |
|||
_time_fraction |
number |
Y |
|||
Clip |
_label |
string |
Y |
||
_range_type |
number |
Y |
Type describing what type of range (time,frame,pct) |
||
_range_start |
number |
Y |
Start of Clip range |
||
_range_stop |
number |
Y |
End of Clip range |
NOTE: Only properties having ‘Param for Update Command’ are modifiable by the user.
NOTE: _uniqueid supports ==, !=, in, and not_in.
Images, videos, and blobs also have the read-only string property
_mime_type. It describes the stored content and supports constraints,
sorting, property indexes, and selection through results.list or
results.all_properties. Retrieval-time media conversions do not change
this property.