MAGE::...raction(3pm)
πΈ MAGE::...raction(3pm) πΈ
okay bestie, gather round β this is the user-contributed Perl documentation for MAGE::...raction(3pm), and it's a lot in the best way. It's giving big-library energy. Let's get into it. π
β¨ NAME β¨
Bio::MAGE::BioAssay::FeatureExtraction β it's the class for the MAGE-OM API, no cap. π
π SYNOPSIS π
use Bio::MAGE::BioAssay::FeatureExtraction
# creating an empty instance
my $featureextraction = Bio::MAGE::BioAssay::FeatureExtraction->new();
# creating an instance with existing data
my $featureextraction = Bio::MAGE::BioAssay::FeatureExtraction->new(
name=>$name_val,
identifier=>$identifier_val,
measuredBioAssayTarget=>$measuredbioassay_ref,
auditTrail=>\@audit_list,
propertySets=>\@namevaluetype_list,
physicalBioAssaySource=>$physicalbioassay_ref,
protocolApplications=>\@protocolapplication_list,
descriptions=>\@description_list,
security=>$security_ref,
);
# 'name' attribute
my $name_val = $featureextraction->name(); # getter
$featureextraction->name($value); # setter
# 'identifier' attribute
my $identifier_val = $featureextraction->identifier(); # getter
$featureextraction->identifier($value); # setter
# 'measuredBioAssayTarget' association
my $measuredbioassay_ref = $featureextraction->measuredBioAssayTarget(); # getter
$featureextraction->measuredBioAssayTarget($measuredbioassay_ref); # setter
# 'auditTrail' association
my $audit_array_ref = $featureextraction->auditTrail(); # getter
$featureextraction->auditTrail(\@audit_list); # setter
# 'propertySets' association
my $namevaluetype_array_ref = $featureextraction->propertySets(); # getter
$featureextraction->propertySets(\@namevaluetype_list); # setter
# 'physicalBioAssaySource' association
my $physicalbioassay_ref = $featureextraction->physicalBioAssaySource(); # getter
$featureextraction->physicalBioAssaySource($physicalbioassay_ref); # setter
# 'protocolApplications' association
my $protocolapplication_array_ref = $featureextraction->protocolApplications(); # getter
$featureextraction->protocolApplications(\@protocolapplication_list); # setter
# 'descriptions' association
my $description_array_ref = $featureextraction->descriptions(); # getter
$featureextraction->descriptions(\@description_list); # setter
# 'security' association
my $security_ref = $featureextraction->security(); # getter
$featureextraction->security($security_ref); # setter
look at all those setters and getters, she's organized β¨
π DESCRIPTION π
Straight from the MAGE-OM documentation for the "FeatureExtraction" class:
The process by which data is extracted from an image producing a measuredBioAssayData and a measuredBioAssay.
π¦ INHERITANCE π¦
Bio::MAGE::BioAssay::FeatureExtraction has the following superclasses:
Bio::MAGE::BioEvent::BioEvent
she comes from a whole lineage, main character family tree fr fr π
π CLASS METHODS π
The following methods can all be called without first having an instance of the class, via the Bio::MAGE::BioAssay::FeatureExtraction->methodname() syntax. classy like that, she doesn't even need an object first π
new()
new(%args)
The object constructor "new()" accepts the following optional named-value style arguments:
nameβ Sets the value of the"name"attribute (this attribute was inherited from class"Bio::MAGE::Identifiable").identifierβ Sets the value of the"identifier"attribute (this attribute was inherited from class"Bio::MAGE::Identifiable").measuredBioAssayTargetβ Sets the value of the"measuredBioAssayTarget"association.
The value must be of type: instance of "Bio::MAGE::BioAssay::MeasuredBioAssay".
auditTrailβ Sets the value of the"auditTrail"association (this association was inherited from class"Bio::MAGE::Describable").
The value must be of type: array of "Bio::MAGE::AuditAndSecurity::Audit".
propertySetsβ Sets the value of the"propertySets"association (this association was inherited from class"Bio::MAGE::Extendable").
The value must be of type: array of "Bio::MAGE::NameValueType".
protocolApplicationsβ Sets the value of the"protocolApplications"association (this association was inherited from class"Bio::MAGE::BioEvent::BioEvent").
The value must be of type: array of "Bio::MAGE::Protocol::ProtocolApplication".
physicalBioAssaySourceβ Sets the value of the"physicalBioAssaySource"association.
The value must be of type: instance of "Bio::MAGE::BioAssay::PhysicalBioAssay".
descriptionsβ Sets the value of the"descriptions"association (this association was inherited from class"Bio::MAGE::Describable").
The value must be of type: array of "Bio::MAGE::Description::Description".
securityβ Sets the value of the"security"association (this association was inherited from class"Bio::MAGE::Describable").
The value must be of type: instance of "Bio::MAGE::AuditAndSecurity::Security".
$obj = class->new(%parameters)
The "new()" method is the class constructor. the blueprint builder, the moment of creation β¨
- Parameters: if given a list of name/value parameters the corresponding slots, attributes, or associations will have their initial values set by the constructor.
- Return value: It returns a reference to an object of the class.
- Side effects: It invokes the
"initialize()"method if it is defined by the class.
@names = class->get_slot_names()
The "get_slot_names()" method is used to retrieve the name of all slots defined in a given class.
NOTE: the list of names does not include attribute or association names. important bestie, don't get it twisted π
- Return value: A list of the names of all slots defined for this class.
- Side effects: none
@name_list = get_attribute_names()
returns the list of attribute data members for this class.
@name_list = get_association_names()
returns the list of association data members for this class.
@class_list = get_superclasses()
returns the list of superclasses for this class.
@class_list = get_subclasses()
returns the list of subclasses for this class.
$name = class_name()
Returns the full class name for this class.
$package_name = package_name()
Returns the base package name (i.e. no 'namespace::') of the package that contains this class.
%assns = associations()
returns the association meta-information in a hash where the keys are the association names and the values are "Association" objects that provide the meta-information for the association.
π INSTANCE METHODS π
$obj_copy = $obj->new()
When invoked with an existing object reference and not a class name, the "new()" method acts as a copy constructor β with the new object's initial values set to be those of the existing object. clone era, twin energy π«Ά
- Parameters: No input parameters are used in the copy constructor, the initial values are taken directly from the object to be copied.
- Return value: It returns a reference to an object of the class.
- Side effects: It invokes the
"initialize()"method if it is defined by the class.
$obj->set_slots(%parameters)
$obj->set_slots(\@name_list, \@value_list)
The "set_slots()" method is used to set a number of slots at the same time. It has two different invocation methods. The first takes a named parameter list, and the second takes two array references.
- Return value: none
- Side effects: will call
"croak()"if a slot_name is used that the class does not define.
heads up bestie β use a slot name she doesn't know and she WILL croak() at you π
@obj_list = $obj->get_slots(@name_list)
The "get_slots()" method is used to get the values of a number of slots at the same time.
- Return value: a list of instance objects
- Side effects: none
$val = $obj->set_slot($name,$val)
The "set_slot()" method sets the slot $name to the value $val
- Return value: the new value of the slot, i.e. $val
- Side effects: none
$val = $obj->get_slot($name)
The "get_slot()" method is used to get the values of a number of slots at the same time.
- Return value: a single slot value, or
undefif the slot has not been initialized. - Side effects: none
πΈ ATTRIBUTES πΈ
Attributes are simple data types that belong to a single instance of a class. In the Perl implementation of the MAGE-OM classes, the interface to attributes is implemented using separate setter and getter methods for each attribute. one for reading, one for writing, she's a two-phone girlie π
"Bio::MAGE::BioAssay::FeatureExtraction" has the following attribute accessor methods:
name
Methods for the "name" attribute.
From the MAGE-OM documentation:
The potentially ambiguous common identifier.
$val = $featureextraction->setName($val)
The restricted setter method for the "name" attribute.
- Input parameters: the value to which the
"name"attribute will be set - Return value: the current value of the
"name"attribute - Side effects: none
- Exceptions: will call
"croak()"if no input parameters are specified, or if too many input parameters are specified
$val = $featureextraction->getName()
The restricted getter method for the "name" attribute.
- Input parameters: none
- Return value: the current value of the
"name"attribute - Side effects: none
- Exceptions: will call
"croak()"if any input parameters are specified
identifier
Methods for the "identifier" attribute.
From the MAGE-OM documentation:
An identifier is an unambiguous string that is unique within the scope (i.e. a document, a set of related documents, or a repository) of its use.
$val = $featureextraction->setIdentifier($val)
The restricted setter method for the "identifier" attribute.
- Input parameters: the value to which the
"identifier"attribute will be set - Return value: the current value of the
"identifier"attribute - Side effects: none
- Exceptions: will call
"croak()"if no input parameters are specified, or if too many input parameters are specified
$val = $featureextraction->getIdentifier()
The restricted getter method for the "identifier" attribute.
- Input parameters: none
- Return value: the current value of the
"identifier"attribute - Side effects: none
- Exceptions: will call
"croak()"if any input parameters are specified
π§ ASSOCIATIONS π§
Associations are references to other classes. Associations in MAGE-OM have a cardinality that determines the minimum and maximum number of instances of the 'other' class that maybe included in the association:
- There must be exactly one item in the association, i.e. this is a mandatory data field.
0..1
There may be one item in the association, i.e. this is an optional data field.
1..N
There must be one or more items in the association, i.e. this is a mandatory data field, with list cardinality.
0..N
There may be one or more items in the association, i.e. this is an optional data field, with list cardinality.
Bio::MAGE::BioAssay::FeatureExtraction has the following association accessor methods, bestie β buckle up, it's giving β¨full rosterβ¨:
measuredBioAssayTarget π
Methods for the measuredBioAssayTarget association.
From the MAGE-OM documentation:
The association between theMeasuredBioAssayand theFeatureExtractionEvent.
$val = $featureextraction->setMeasuredBioAssayTarget($val)- The restricted setter method for the
measuredBioAssayTargetassociation. - Input parameters: the value to which the
measuredBioAssayTargetassociation will be set : one of the accepted enumerated values. - Return value: the current value of the
measuredBioAssayTargetassociation : one of the accepted enumerated values. - Side effects: none
- Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$valis not an instance of classBio::MAGE::BioAssay::MeasuredBioAssay
- The restricted setter method for the
$val = $featureextraction->getMeasuredBioAssayTarget()- The restricted getter method for the
measuredBioAssayTargetassociation. - Input parameters: none
- Return value: the current value of the
measuredBioAssayTargetassociation : an instance of typeBio::MAGE::BioAssay::MeasuredBioAssay. - Side effects: none
- Exceptions: will call
croak()if any input parameters are specified
- The restricted getter method for the
auditTrail π¦
Methods for the auditTrail association.
From the MAGE-OM documentation:
A list of Audit instances that track changes to the instance of Describable.
$array_ref = $featureextraction->setAuditTrail($array_ref)- The restricted setter method for the
auditTrailassociation. - Input parameters: the value to which the
auditTrailassociation will be set : a reference to an array of objects of typeBio::MAGE::AuditAndSecurity::Audit - Return value: the current value of the
auditTrailassociation : a reference to an array of objects of typeBio::MAGE::AuditAndSecurity::Audit - Side effects: none
- Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$array_refis not a reference to an array classBio::MAGE::AuditAndSecurity::Auditinstances
- The restricted setter method for the
$array_ref = $featureextraction->getAuditTrail()- The restricted getter method for the
auditTrailassociation. - Input parameters: none
- Return value: the current value of the
auditTrailassociation : a reference to an array of objects of typeBio::MAGE::AuditAndSecurity::Audit - Side effects: none
- Exceptions: will call
croak()if any input parameters are specified
- The restricted getter method for the
$val = $featureextraction->addAuditTrail(@vals)- Because the
auditTrailassociation has list cardinality, it may store more than one value. This method adds the current list of objects in theauditTrailassociation. - Input parameters: the list of values
@valsto add to theauditTrailassociation. NOTE: submitting a single value is permitted. - Return value: the number of items stored in the slot after adding
@vals - Side effects: none
- Exceptions: will call
croak()if no input parameters are specified, or if any of the objects in@valsis not an instance of classBio::MAGE::AuditAndSecurity::Audit
- Because the
propertySets π
Methods for the propertySets association.
From the MAGE-OM documentation:
Allows specification of name/value pairs. Meant to primarily help in-house, pipeline processing of instances by providing a place for values that aren't part of the specification proper.
$array_ref = $featureextraction->setPropertySets($array_ref)- The restricted setter method for the
propertySetsassociation. - Input parameters: the value to which the
propertySetsassociation will be set : a reference to an array of objects of typeBio::MAGE::NameValueType - Return value: the current value of the
propertySetsassociation : a reference to an array of objects of typeBio::MAGE::NameValueType - Side effects: none
- Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$array_refis not a reference to an array classBio::MAGE::NameValueTypeinstances
- The restricted setter method for the
$array_ref = $featureextraction->getPropertySets()- The restricted getter method for the
propertySetsassociation. - Input parameters: none
- Return value: the current value of the
propertySetsassociation : a reference to an array of objects of typeBio::MAGE::NameValueType - Side effects: none
- Exceptions: will call
croak()if any input parameters are specified
- The restricted getter method for the
$val = $featureextraction->addPropertySets(@vals)- Because the
propertySetsassociation has list cardinality, it may store more than one value. This method adds the current list of objects in thepropertySetsassociation. - Input parameters: the list of values
@valsto add to thepropertySetsassociation. NOTE: submitting a single value is permitted. - Return value: the number of items stored in the slot after adding
@vals - Side effects: none
- Exceptions: will call
croak()if no input parameters are specified, or if any of the objects in@valsis not an instance of classBio::MAGE::NameValueType
- Because the
protocolApplications πΈ
Methods for the protocolApplications association.
From the MAGE-OM documentation:
The applied protocols to the BioEvent.
$array_ref = $featureextraction->setProtocolApplications($array_ref)- The restricted setter method for the
protocolApplicationsassociation. - Input parameters: the value to which the
protocolApplicationsassociation will be set : a reference to an array of objects of typeBio::MAGE::Protocol::ProtocolApplication - Return value: the current value of the
protocolApplicationsassociation : a reference to an array of objects of typeBio::MAGE::Protocol::ProtocolApplication - Side effects: none
- Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$array_refis not a reference to an array classBio::MAGE::Protocol::ProtocolApplicationinstances
- The restricted setter method for the
$array_ref = $featureextraction->getProtocolApplications()- The restricted getter method for the
protocolApplicationsassociation. - Input parameters: none
- Return value: the current value of the
protocolApplicationsassociation : a reference to an array of objects of typeBio::MAGE::Protocol::ProtocolApplication - Side effects: none
- Exceptions: will call
croak()if any input parameters are specified
- The restricted getter method for the
$val = $featureextraction->addProtocolApplications(@vals)- Because the
protocolApplicationsassociation has list cardinality, it may store more than one value. This method adds the current list of objects in theprotocolApplicationsassociation. - Input parameters: the list of values
@valsto add to theprotocolApplicationsassociation. NOTE: submitting a single value is permitted. - Return value: the number of items stored in the slot after adding
@vals - Side effects: none
- Exceptions: will call
croak()if no input parameters are specified, or if any of the objects in@valsis not an instance of classBio::MAGE::Protocol::ProtocolApplication
- Because the
physicalBioAssaySource π§
Methods for the physicalBioAssaySource association.
From the MAGE-OM documentation:
The PhysicalBioAssay used in the FeatureExtraction event.
$val = $featureextraction->setPhysicalBioAssaySource($val)- The restricted setter method for the
physicalBioAssaySourceassociation. - Input parameters: the value to which the
physicalBioAssaySourceassociation will be set : one of the accepted enumerated values. - Return value: the current value of the
physicalBioAssaySourceassociation : one of the accepted enumerated values. - Side effects: none
- Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$valis not an instance of classBio::MAGE::BioAssay::PhysicalBioAssay
- The restricted setter method for the
$val = $featureextraction->getPhysicalBioAssaySource()- The restricted getter method for the
physicalBioAssaySourceassociation. - Input parameters: none
- Return value: the current value of the
physicalBioAssaySourceassociation : an instance of typeBio::MAGE::BioAssay::PhysicalBioAssay. - Side effects: none
- Exceptions: will call
croak()if any input parameters are specified
- The restricted getter method for the
descriptions π
Methods for the descriptions association.
From the MAGE-OM documentation:
Free hand text descriptions. Makes available the associations of Description to an instance of Describable.
$array_ref = $featureextraction->setDescriptions($array_ref)- The restricted setter method for the
descriptionsassociation. - Input parameters: the value to which the
descriptionsassociation will be set : a reference to an array of objects of typeBio::MAGE::Description::Description - Return value: the current value of the
descriptionsassociation : a reference to an array of objects of typeBio::MAGE::Description::Description - Side effects: none
- The restricted setter method for the
- Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$array_refis not a reference to an array classBio::MAGE::Description::Descriptioninstances
$array_ref = $featureextraction->getDescriptions()
The restricted getter for the descriptions association. Like, the read-only bestie π
- Input parameters: none
- Return value: the current value of the
descriptionsassociation β a reference to an array of objects of typeBio::MAGE::Description::Description - Side effects: none
- Exceptions: will call
croak()if any input parameters are specified
$val = $featureextraction->addDescriptions(@vals)
Okay so because the descriptions association has list cardinality, it can hold more than one value β she's not a one-value girlie. This method adds the current list of objects in the descriptions association. β¨
- Input parameters: the list of values
@valsto add to thedescriptionsassociation. NOTE: submitting a single value is permitted. (yes bestie, one is fine, we don't judge π) - Return value: the number of items stored in the slot after adding
@vals - Side effects: none
- Exceptions: will call
croak()if no input parameters are specified, or if any of the objects in@valsis not an instance of classBio::MAGE::Description::Description
π security
Methods for the security association. She's the bodyguard of the class, no cap.
From the MAGE-OM documentation:
Information on the security for the instance of the class.
$val = $featureextraction->setSecurity($val)
The restricted setter for the security association.
- Input parameters: the value to which the
securityassociation will be set : one of the accepted enumerated values. - Return value: the current value of the
securityassociation : one of the accepted enumerated values. - Side effects: none
- Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$valis not an instance of classBio::MAGE::AuditAndSecurity::Security
$val = $featureextraction->getSecurity()
The restricted getter for the security association.
- Input parameters: none
- Return value: the current value of the
securityassociation : an instance of typeBio::MAGE::AuditAndSecurity::Security. - Side effects: none
- Exceptions: will call
croak()if any input parameters are specified
And then, iconically, there's just... this whole method sitting here. Full main character energy π
sub initialize {
my $self = shift;
return 1;
}
ποΈ SLOTS, ATTRIBUTES, AND ASSOCIATIONS
Okay bestie, listen up because this is the part that makes everything click. In the Perl implementation of MAGE-OM classes, there are three types of class data members: slots, attributes, and associations. Three flavors. All valid. π
SLOTS
This API uses the term slot to indicate a data member of the class that was not present in the UML model and is used for mainly internal purposes β use only if you understand the inner workings of the API. Like, fr, only touch this if you actually know what you're doing π Most often slots are used by generic methods such as those in the XML writing and reading classes.
Slots are implemented using unified getter/setter methods:
$var = $obj->slot_name();β Retrieves the current value of the slot.$new_var = $obj->slot_name($new_var);β Store$new_varin the slot β the return value is also$new_var.@names = $obj->get_slot_names()β Returns the list of all slots in the class.
DATA CHECKING: No data type checking is made for these methods. She does NOT check your vibes. π
ATTRIBUTES AND ASSOCIATIONS
The terms attribute and association indicate data members of the class that were specified directly from the UML model. So these ones are the real, official, canon ones. π
In the Perl implementation of MAGE-OM classes, association and attribute accessors are implemented using three separate methods:
get*β Retrieves the current value.- NOTE: For associations, if the association has list cardinality, an array reference is returned.
- DATA CHECKING: Ensure that no argument is provided.
set*β Sets the current value, replacing any existing value.- NOTE: For associations, if the association has list cardinality, the argument must be an array reference. Because of this, you probably should be using the
add*methods. (lowkey a hint, take it bestie π«Ά) - DATA CHECKING: For attributes, ensure that a single value is provided as the argument. For associations, if the association has list cardinality, ensure that the argument is a reference to an array of instances of the correct MAGE-OM class, otherwise ensure that there is a single argument of the correct MAGE-OM class.
- NOTE: For associations, if the association has list cardinality, the argument must be an array reference. Because of this, you probably should be using the
add*β NOTE: Only present in associations with list cardinality.- Appends a list of objects to any values that may already be stored in the association.
- DATA CHECKING: Ensure that all arguments are of the correct MAGE-OM class.
GENERIC METHODS
The unified base class of all MAGE-OM classes, Bio::MAGE::Base, provides a set of generic methods that will operate on slots, attributes, and associations. One class to rule them all, periodt. β¨
$val = $obj->get_slot($name)
\@list_ref = $obj->get_slots(@name_list);
$val = $obj->set_slot($name,$val)
$obj->set_slots(%parameters)
$obj->set_slots(\@name_list, \@value_list)
See elsewhere in this page for a detailed description of these methods. (she's keeping it mysterious π )
π BUGS
Please send bug reports to the project mailing list: (mged-mage 'at' lists 'dot' sf 'dot' net)
Like, actually send them though. Don't just sit there with your broken code and your feelings. π
π AUTHOR
Jason E. Stewart (jasons 'at' cpan 'dot' org)
The icon. The legend. The moment. We stan. π
π SEE ALSO
π©Ή POD ERRORS
Hey! The above document had some coding errors, which are explained below. Not me being messy in the docs π every legend has a little chaos:
- Around line 395:
'=item' outside of any '=over'
- Around line 480:
You forgot a '=back' before '=head2'
- Around line 652:
Expected '=item 2'
- Around line 657:
Expected '=item 3'
- Around line 662:
Expected '=item 4'
And that's a wrap on this whole page bestie π she shipped as perl v5.32.0, dated 2020-11-27, and she's still out here doing the absolute most. Go write some MAGE-OM code, you've got this. πβ¨π¦
π¦ where this page comes from
- debian bookworm: libbio-mage-perl 20030502.3-6 Β· MIT
- debian trixie: libbio-mage-perl 20030502.3-6 Β· MIT
- ubuntu jammy: libbio-mage-perl 20030502.3-6 Β· MIT
- ubuntu noble: libbio-mage-perl 20030502.3-6 Β· MIT
- ubuntu resolute: libbio-mage-perl 20030502.3-6 Β· MIT
- ubuntu stonking: libbio-mage-perl 20030502.3-6 Β· MIT
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms