Page Comparison

With the Object Relation Tool, you can define rules for relating objects. When objects are related, you can calculate relative measurements, such as the numbers of overlapped objects or distances between objects.

On this page:

Table of Contents

minLevel	1
maxLevel	5

Rule definition

The top section of the Object Relation Tool window has options for creating rules, which are described in the table below.

Name	Description
Rule Name	Specifies the name of the relation rule
Association Rule	Specifies the type of relation rule
Max Search Range	Specifies the maximum allowable distance between objects for Nearest relation rules
Primary Set	Specifies the primary object set for the relation rule
Associate Set	Specifies the associate object set for the relation rule
Clear	Returns the the top section to its default state
Add	Adds the rule specified in the top section to the table of relation rules below

Rule types

Rule Option 1	Rule Option 2	Outlines and 2D Tracks	Meshes and 3D Tracks	Description
Overlap	Any	x	x	Relates each object in the primary set with each overlapping object in the associate set
Overlap	Full	x	x	Relates each object in the primary set with each object in the associate set that is fully enclosed by the primary object
Overlap	Semi	x	x	Relates each object in the primary set with each object in the associate set that partially, but not fully, overlaps the primary object
Overlap	Best Match	x		Relates each object in the primary set with the overlapped object in the associate set with the nearest centroid (center of bounding box) to the primary object’s centroid
Overlap	Min Percent	x		Relates each object in the primary set with each object in the associate set that overlaps the primary object by at least the minimum percentage specified in the numeric entry box to the right of the Min Percent button of the associated object’s area
Nearest	Best Match	x		Relates each object in the primary set with the object in the associate set with the nearest centroid (center of bounding box) to the primary object’s centroid, up to a bounding box distance of 150 pixelsthe specified Max Search Range

Using the Object Relation Tool

When you have two object sets you would like to relate, go to the Spreadsheet in Aivia , and then click on the Object Relation Tool icon to open the Object Relation Tool window. Specify the name of the relation rule in the Rule Name textbox, set the relation rule type in the Association Rule section, and select the object sets to relate in the Primary Set and Associate Set menus. Review the Rule Types section of this page to determine which object set to set as the primary one. Then, click Add to add the rule into the table of relation rules. Check the Open Measurements Dialog on Apply checkbox if you would like to change or add any measurements immediately after the relations are calculated, and then click Apply to calculate the relations.

Adding relation measurements

Once relations are established, you can add relation measurements to the related object sets with the Measurement Tool.

Image RemovedImage Added

The available, pre-defined relation measurements are given in the table below along with which measurements are available for 2D objects, which measurements are available for 3D objects, which measurements are only available for track (multi-timepoint) objects, which measurements are calculated (non-blank) for the related objects in the Primary Set, and which measurements are calculated for the related objects in the Associate Set. Refer to the Relation section of the Measurement Definitions page for the corresponding measurement definitions.

Measurement	2D Objects	3D Objects	Related Tracks Only	Primary Objects	Associated/Secondary Objects
% Overlapped	x			x
All Relations Count	x	x	x	x	x
Area Overlapped	x			x
First Relation Frame	x	x	x	x	x
Has Relation	x	x	x	x	x
Last Relation Frame	x	x	x	x	x
Relation Primary Count	x	x	x	x	x
Relation Secondary Count	x	x	x	x	x
Relations on Frame	x	x		x	x
Relative Acceleration	x	x	x		x
Relative Center of Mass Distance	x	x			x
Relative Center of Mass X	x	x			x
Relative Center of Mass Y	x	x			x
Relative Center of Mass Z		x			x
Relative Distance	x	x			x
Minimum Relative Distance	x	x		x
Relative Straight Line Velocity	x	x	x	x
Relative Straight Line Velocity Squared	x	x	x	x
Relative Velocity	x	x	x		x
Relative X Position	x	x			x
Relative Y Position	x	x			x
Relative Z Position		x			x

Adding custom, advanced relation measurements

You can use the Advanced Measurements tool to create custom measurements for objects related through the Object Relation Tool. Some Advanced Measurement Functions that may be useful for your custom relation measurements are in the table below.

Function Name(Input 1, Input 2,...)	Description
RelationCount()	Returns the number of objects that are related to the tracked object
RelationCount(Related Object Set)	Returns the number of objects that are related to the tracked object from the specified object set
RelationCountAtFrame()	Returns the number of objects that are related to the object on any given frame, excluding objects related through lineage
RelationCountAtFrame(Related Object Set)	Returns the number of objects that are related to the object from the specified object set on any given frame, excluding objects related through lineage
RelatedObjects(Statistic Type, Measurement to Summarize)	Calculates the statistical type on the related objects
RelatedObjects(Statistic Type, Measurement to Summarize, Related Object Set)	Calculates the statistical type on the related objects which are from the specified, related object set
RelatedSecondaryObjects(Statistic Type, Measurement to Summarize, Related Object Set)	Calculates the statistical type on the related objects which are from the related object set; the primary related objects are the ones which are statistically grouped

Viewing relations with the Relational Spreadsheet

The Relational Spreadsheet can be helpful for identifying which objects are related. To view the Relational Spreadsheet, click on the Relational Spreadsheet icon (see right) along the left edge of the Spreadsheet tab.

The Relational Spreadsheet can be used to view multiple types of object hierarchies, but to view relations defined with the Object Relation Tool, choose the ObjectRelation option in the Type menu. The Relational Spreadsheet has three main sections: the hierarchy view, the primary/parent object section, and the secondary/associate/child objects section (see below).

To view the children of an object in the hierarchy view, click on the Expand icon (rightward pointing triangle) to the left of the object’s name. Selecting an object in the hierarchy view such that it is highlighted in blue leads to its measurements being displayed in the primary/parent object section and the measurements for its child objects being displayed in the secondary/associate/child objects section. Only child objects on the current time frame in the object set specified in the Object Set menu are displayed in the secondary/associate/child objects section.

Exporting relations

To export which objects are related to which other objects in CSV format, click on the Export to Excel icon in the Spreadsheet, choose the Export Relations option (see below), navigate to a folder you would like to output the CSVs to, and then click Select Folder. The designated folder is then populated with a CSV file for each object set on the image that is related to another object set. For each object set, the first column of its CSV contains each object with a (primary or secondary) relation. There is a subsequent column for each related object set with the objects related to the object in the first column given in the same row.

Image RemovedImage Added

Versions Compared

Old Version 5

New Version 6

Key

Interface