annotate variant_effect_predictor/Bio/EnsEMBL/DensityFeature.pm @ 0:1f6dce3d34e0

Uploaded
author mahtabm
date Thu, 11 Apr 2013 02:01:53 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1 =head1 LICENSE
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
2
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
3 Copyright (c) 1999-2012 The European Bioinformatics Institute and
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
4 Genome Research Limited. All rights reserved.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
5
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
6 This software is distributed under a modified Apache license.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
7 For license details, please see
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
8
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
9 http://www.ensembl.org/info/about/code_licence.html
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
10
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
11 =head1 CONTACT
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
12
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
13 Please email comments or questions to the public Ensembl
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
14 developers list at <dev@ensembl.org>.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
15
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
16 Questions may also be sent to the Ensembl help desk at
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
17 <helpdesk@ensembl.org>.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
18
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
19 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
20
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
21 =head1 NAME
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
22
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
23 Bio::EnsEMBL::DensityFeature - A feature representing a density, or
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
24 precentage coverage etc. in a given region.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
25
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
26 =head1 SYNOPSIS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
27
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28 use Bio::EnsEMBL::DensityFeature;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30 $feature = Bio::EnsEMBL::DensityFeature->new(
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31 -seq_region => $region,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32 -start => 1,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33 -end => 1e6,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34 -density_type => $dt,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35 -density_value => 98.5
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36 );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40 A density feature represents a count, density, or percentage coverage,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41 etc. for a given region.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43 This module is part of the Ensembl project http://www.ensembl.org
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45 =head1 METHODS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51 use warnings;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53 package Bio::EnsEMBL::DensityFeature;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55 use Bio::EnsEMBL::Feature;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56 use Bio::EnsEMBL::Utils::Argument qw(rearrange);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57 use Bio::EnsEMBL::Utils::Exception qw(throw);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58 use Bio::EnsEMBL::DensityType;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60 use vars qw(@ISA);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62 @ISA = qw(Bio::EnsEMBL::Feature);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65 =head2 new
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67 Arg [SEQ_REGION] : the sequence over which the density was calculated.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69 Arg [START] : start point on the seq at which density was calulated.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71 Arg [END] : end point on the seq at which density was calulated.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73 Arg [DENSITY_TYPE] : the type of density calculated.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75 Arg [DENSITY_VALUE] : the density.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77 Arg [...] : Named arguments passed to superclass
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78 Example : $feature = Bio::EnsEMBL::DensityFeature->new
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79 (-seq_region => $region,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80 -start => 1,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81 -end => 1e6,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82 -density_type => $dt,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83 -density_value => 98.5)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85 Description: Creates a new density feature.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86 Returntype : Bio::EnsEMBL::DensityFeature
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87 Exceptions : throw if invalid density value type is provided
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93 sub new {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94 my $caller = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96 #allow constructor to be called as class or object method
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 my $class = ref($caller) || $caller;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99 my $self = $class->SUPER::new(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101 my($seq_region, $start, $end, $dt, $dv) =
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102 rearrange(['SEQ_REGION', 'START', 'END', 'DENSITY_TYPE', 'DENSITY_VALUE'],
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103 @_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105 throw("Density value must be >= 0.") if($dv < 0);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107 if(!defined($dt)){
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108 throw("Density Type is NOT optional.");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
109 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
110
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
111 $self->{'density_type'} = $dt;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
112 $self->{'density_value'} = $dv;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
113
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
114 $self->{'slice'} = $seq_region;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
115 $self->{'start'} = $start;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
116 $self->{'end'} = $end;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
117
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
118
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
119 return $self;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
120 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
121
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
122
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
123 =head2 new_fast
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
124
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
125 Arg [...] : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
126 Example : $feature = Bio::EnsEMBL::DensityFeature->new_fast();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
127 Description: Creates a new density feature.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
128 Returntype : Bio::EnsEMBL::DensityFeature
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
129 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
130 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
131 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
132
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
133 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
134
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
135 sub new_fast{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
136 my $caller = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
137
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
138 #allow constructor to be called as class or object method
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
139 my $class = ref($caller) || $caller;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
140
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
141 my $self = $class->SUPER::new(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
142
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
143 return $self;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
144 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
145
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
146
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
147 =head2 strand
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
148
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
149 Arg [1] : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
150 Example : $strand = $df->strand();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
151 Description: Getter fot the strand attribute. Density features always have
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
152 strand 0 and this attribute is not settable.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
153 Returntype : int (always 0)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
154 Exceptions : warning if an attempt is made to set the strand
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
155 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
156 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
157
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
158 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
159
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
160 sub strand {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
161 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
162 warning("DensityFeature strand is not settable") if(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
163 return 0;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
164 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
165
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
166
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
167
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
168 =head2 density_value
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
169
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
170 Arg [1] : (optional) float $density_value
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
171 Example : $dv = $density_feature->density_value();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
172 Description: Getter/Setter for the density value of this DensityFeature.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
173 The density value may be a count, a percentage, or a coverage
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
174 of a feature type in the area defined by this feature.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
175 Returntype : float
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
176 Exceptions : throw if a negative density value is provided
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
177 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
178 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
179
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
180 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
181
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
182 sub density_value {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
183 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
184
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
185 if(@_) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
186 my $density_value = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
187 throw("Density value must be >= 0.") if($density_value < 0);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
188 $self->{'density_value'} = $density_value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
189 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
190
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
191 return $self->{'density_value'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
192 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
193
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
194
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
195
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
196 =head2 analysis
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
197
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
198 Arg [1] : (optional) Bio::EnsEMBL::Analysis $analysis
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
199 New value for the analysis of the attached DensityType
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
200 Example : print $df->analysis()->logic_name();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
201 Description: Overridden superclass analysis method, to chain to analysis
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
202 method on attached DensityType.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
203 Returntype : Bio::EnsEMBL::Analysis
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
204 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
205 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
206 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
207
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
208 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
209
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
210 sub analysis {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
211 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
212
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
213 my $dt = $self->density_type();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
214
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
215 return undef if(!$dt);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
216
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
217 return $dt->analysis(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
218 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
219
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
220
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
221
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
222 =head2 density_type
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
223
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
224 Arg [1] : string $newval (optional)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
225 The new value to set the density_value_type attribute to
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
226 Example : $density_value_type = $obj->density_value_type()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
227 Description: Getter/Setter for the density_value_type attribute
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
228 Returntype : Bio::EnsEMBL::DensityType
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
229 Exceptions : if object passed is not of type DensityType
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
230 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
231 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
232
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
233 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
234
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
235 sub density_type{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
236 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
237 if(@_) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
238 my $type = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
239 if( !ref $type || !$type->isa("Bio::EnsEMBL::DensityType")){
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
240 throw("object passed must be an ensembl DensityType ".
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
241 "not a [".ref($type)."]");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
242 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
243 else{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
244 $self->{'density_type'}=$type;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
245 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
246 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
247 return $self->{'density_type'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
248 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
249
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
250
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
251 ###BG########
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
252
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
253 =head2 scaledvalue
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
254
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
255 Title : scaledvalue
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
256 Usage : $obj->scaledvalue($newval)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
257 Function:
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
258 Returns : scalar - object's scaled value
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
259 Args : newvalue (optional)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
260 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
261
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
262 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
263
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
264 sub scaledvalue{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
265 my $obj = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
266 if( @_ ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
267 my $scaledvalue = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
268 $obj->{'scaledvalue'} = $scaledvalue;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
269 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
270 return $obj->{'scaledvalue'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
271 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
272
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
273
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
274
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
275 =head2 url
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
276
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
277 Title : url
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
278 Usage : $obj->url($newval)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
279 Function:
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
280 Returns : String containing this object's url
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
281 Args : newvalue (optional)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
282 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
283
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
284
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
285 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
286
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
287 sub url{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
288 my $obj = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
289 if( @_ ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
290 my $url = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
291 $obj->{'url'} = $url;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
292 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
293 return $obj->{'url'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
294
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
295 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
296
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
297
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
298 1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
299
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
300
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
301