Package madrona :: Package studyregion :: Module models :: Class StudyRegion

Class StudyRegion

django.contrib.gis.db.models.Model --+
                                     |
                                    StudyRegion

Model used for representing study regions

======================  ==============================================
Attribute               Description
======================  ==============================================

``name``                Name of the Study Region

``active``              Whether the study region is treated as the
                        current authoritative copy. This should not be
                        set using the admin interface

``creation_date``       Automatically assigned

``modification_date``   Automatically assigned

``geometry``            PolygonField representing the study region boundary

``date_modified``       When the Study Region geometry was last updated.

``lookAt_Lat``          Latitude of the default look-at point

``lookAt_Lon``          Longitude of the default look-at point

``lookAt_Range``        Range camera sits from the default look-at point

``lookAt_Tilt``         Angle offset from vertical for default camera pos

``lookAt_Heading``      Angle offset from North for default camera pos

======================  ==============================================

Nested Classes

[hide private]

get_absolute_url(self)

source code

Decorators:

@models.permalink

area_sq_mi(self)

source code

WARNING: This method assumes that the native units of the geometry are meters. Returns the area of the study region in sq_mi

Decorators:

@property

Class Variable Details

[hide private]

name

Value:

models.CharField(verbose_name= "Study Region Name", max_length= 255)

active

Value:

models.BooleanField(default= False, help_text= 'This options will usua
lly not be set using the admin interface, but rather by using the mana
gement commands relating to study region changes.')

geometry

Value:

models.MultiPolygonField(srid= settings.GEOMETRY_DB_SRID, null= True, 
blank= True, verbose_name= "Study region boundary")

date_modified

Value:

models.DateTimeField(auto_now= True, verbose_name= "Date Modified")

lookAt_Lat

Value:

models.FloatField(default= 0, null= True, blank= True)

lookAt_Lon

Value:

models.FloatField(default= 0, null= True, blank= True)

lookAt_Range

Value:

models.FloatField(default= 80000, help_text= 'Distance from lookAt poi
nt in meters')

lookAt_Tilt

Value:

models.FloatField(default= 0, help_text= 'Degrees from vertical (0=dir
ectly above)')

lookAt_Heading

Value:

models.FloatField(default= 0, help_text= 'View direction in degrees (0
=look North)')