FISH Functions

The type specifiers used in the FISH function signatures are given in the “FISH Type Index” section.

Data Label Utilities

data.label.arrow(UDL_PNT) Get/set arrow status.
data.label.create(VEC<,INT/STR>) Create a label.
data.label.delete(UDL_PNT) Delete a label.
data.label.end(UDL_PNT<,INT>) Get/set the end position.
data.label.find(INT/STR) Find a label.
data.label.head Get the head of the global label list.
data.label.list Get the global label list.
data.label.maxid Get the maximum label ID.
data.label.name(UDL_PNT) Get the label name.
data.label.next(UDL_PNT) Get the next label.
data.label.num Get the number of labels.
data.label.pos(UDL_PNT<,INT>) Get/set the position.
data.label.text(UDL_PNT) Get/set the label text.
data.label.typeid Get the label type ID number.

Data Scalar Utilities

data.scalar.create(VEC) Create a scalar.
data.scalar.delete(UDS_PNT) Delete the scalar.
data.scalar.extra(UDS_PNT<,INT>) Get/set a scalar extra variable.
data.scalar.find(INT) Find a scalar.
data.scalar.group(UDS_PNT<,INT/STR>) Get/set a scalar group.
data.scalar.group.remove(UDS_PNT,INT/STR) Remove scalar groups.
data.scalar.head Get the head of the global list of scalars.
data.scalar.id(UDS_PNT) Get the scalar ID.
data.scalar.isgroup(UDS_PNT,INT/STR<,INT/STR>) Query the existence of a group.
data.scalar.list Get the global scalar list.
data.scalar.maxid Get the maximum scalar ID.
data.scalar.near(VEC<,FLT>) Find the closest scalar to a point.
data.scalar.next(UDS_PNT) Get the next scalar.
data.scalar.num Get the number of scalars.
data.scalar.pos(UDS_PNT<,INT>) Get/set the scalar position.
data.scalar.typeid Get the scalar type ID number.
data.scalar.value(UDS_PNT) Get/set the scalar value.

Data Tensor Utilities

data.tensor.create(VEC) Create a tensor.
data.tensor.delete(UDT_PNT) Delete the tensor.
data.tensor.extra(UDT_PNT<,INT>) Get/set a tensor extra variable.
data.tensor.find(INT) Find a tensor.
data.tensor.group(UDT_PNT<,INT/STR>) Get/set a tensor group.
data.tensor.group.remove(UDT_PNT,INT/STR) Remove tensor groups.
data.tensor.head Get the head of the global list of tensors.
data.tensor.id(UDT_PNT) Get the tensor ID.
data.tensor.isgroup(UDT_PNT,INT/STR<,INT/STR>) Query the existence of a group.
data.tensor.list Get the global tensor list.
data.tensor.maxid Get the maximum tensor ID.
data.tensor.near(VEC<,FLT>) Find the closest tensor to a point.
data.tensor.next(UDT_PNT) Get the next tensor.
data.tensor.num Get the number of tensors.
data.tensor.pos(UDT_PNT<,INT>) Get/set the tensor position.
data.tensor.typeid Get the tensor type ID number.
data.tensor.value(UDT_PNT<,INT<,INT>>) Get/set the tensor value.

Data Vector Utilities

data.vector.create(VEC) Create a vector.
data.vector.ddir(UDV_PNT)(3D only) Get/set the vector dip direction.
data.vector.delete(UDV_PNT) Delete the vector.
data.vector.dip(UDV_PNT) Get/set the vector dip.
data.vector.extra(UDV_PNT<,INT>) Get/set a vector extra variable.
data.vector.find(INT) Find a vector.
data.vector.group(UDV_PNT<,INT/STR>) Get/set vector groups.
data.vector.group.remove(UDV_PNT,INT/STR) Remove vector groups.
data.vector.head Get the head of the global list of vectors.
data.vector.id(UDV_PNT) Get the vector ID.
data.vector.isgroup(UDV_PNT,INT/STR<,INT/STR>) Query the existence of a group.
data.vector.list Get the global vector list.
data.vector.maxid Get the maximum vector ID.
data.vector.near(VEC<,FLT>) Find the closest vector to a point.
data.vector.next(UDV_PNT) Get the next vector.
data.vector.num Get the number of vectors.
data.vector.pos(UDV_PNT<,INT>) Get/set the vector position.
data.vector.typeid Get the vector type ID number.
data.vector.value(UDV_PNT<,INT>) Get/set the vector value.