Bio::Coordinate::MapperI - Interface describing coordinate mappers
# not to be used directly
MapperI defines methods for classes capable for mapping locations between coordinate systems.
User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to the Bioperl mailing lists Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion http://bio.perl.org/MailList.html - About the mailing lists
report bugs to the Bioperl bug tracking system to help us keep track the bugs and their resolution. Bug reports can be submitted via email or the web:
bioperl-bugs@bio.perl.org http://bugzilla.bioperl.org/
Email: heikki@ebi.ac.uk Address:
EMBL Outstation, European Bioinformatics Institute
Wellcome Trust Genome Campus, Hinxton
Cambs. CB10 1SD, United Kingdom
Additional contributors names and emails here
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
Title : in
Usage : $obj->in('peptide');
Function: Set and read the input coordinate system.
Example :
Returns : value of input system
Args : new value (optional), Bio::LocationI
Title : out
Usage : $obj->out('peptide');
Function: Set and read the output coordinate system.
Example :
Returns : value of output system
Args : new value (optional), Bio::LocationI
Title : swap Usage : $obj->swap; Function: Swap the direction of mapping: input <-> output) Example : Returns : 1 Args :
Title : test Usage : $obj->test; Function: test that both components are of same length Example : Returns : ( 1 | undef ) Args :
Title : map
Usage : $newpos = $obj->map($loc);
Function: Map the location from the input coordinate system
to a new value in the output coordinate system.
Example :
Returns : new value in the output coordiante system
Args : Bio::LocationI
Title : return_match
Usage : $obj->return_match(1);
Function: A flag to turn on the simplified mode of
returning only one joined Match object or undef
Example :
Returns : boolean
Args : boolean (optional)