Previous topic

stalker.core.models.imageFormat

Next topic

stalker.core.models.link

This Page

stalker.core.models.imageFormat.ImageFormat

Inheritance diagram of stalker.core.models.imageFormat.ImageFormat

class stalker.core.models.imageFormat.ImageFormat(width=None, height=None, pixel_aspect=1.0, print_resolution=300, **kwargs)[source]

Bases: stalker.core.models.entity.Entity

Common image formats for the projects.

adds up this parameters to the SimpleEntity:

Parameters:
  • width – the width of the format, it cannot be zero or negative, if a float number is given it will be converted to integer
  • height – the height of the format, it cannot be zero or negative, if a float number is given it will be converted to integer
  • pixel_aspect – the pixel aspect ratio of the current ImageFormat object, it can not be zero or negative, and if given as an integer it will be converted to a float, the default value is 1.0
  • print_resolution – the print resolution of the ImageFormat given as DPI (dot-per-inch). It can not be zero or negative
__init__(width=None, height=None, pixel_aspect=1.0, print_resolution=300, **kwargs)[source]

Methods

__init__(**kwargs[, width, height, ...])

Attributes

code The code name of this object.
created_by The User who has created
date_created A datetime.datetime instance showing the creation
date_updated A datetime.datetime instance showing the update
description Description of this object.
device_aspect returns the device aspect
height this is a property to set and get the height of the
name name of this object
nice_name The nice name of this object.
notes all the notes about this entity, it should be a list of Notes
pixel_aspect this is a property to set and get the pixel_aspect of the
print_resolution this is a property to set and get the print_resolution of the
tags a list of Tag objects which shows the related tags to the
updated_by The User who has updated
width this is a property to set and get the width of the
width[source]

this is a property to set and get the width of the image_format

  • the width should be set to a positif non-zero integer
  • integers are also accepted but will be converted to float
  • for improper inputs the object will raise a ValueError
height[source]

this is a property to set and get the height of the image_format

  • the height should be set to a positif non-zero integer
  • integers are also accepted but will be converted to float
  • for improper inputs the object will raise a ValueError
pixel_aspect[source]

this is a property to set and get the pixel_aspect of the ImageFormat

  • the pixel_aspect should be set to a positif non-zero float
  • integers are also accepted but will be converted to float
  • for improper inputs the object will raise a ValueError
code

The code name of this object.

It accepts string or unicode values and any other kind of objects will be converted to string. In any update to the name attribute the code also will be updated to the uppercase form of the nice_name attribute. If the not initialized or given as None, it will be set to the uppercase version of the nice_name attribute. Setting the code attribute to None will reset it to the default value. The default value is the upper case form of the nice_name.

created_by

The User who has created this object.

date_created

A datetime.datetime instance showing the creation date and time of this object.

date_updated

A datetime.datetime instance showing the update date and time of this object.

description

Description of this object.

device_aspect[source]

returns the device aspect

because the device_aspect is calculated from the width/height*pixel formula, this property is read-only.

name

name of this object

nice_name

The nice name of this object.

It has the same value with the name (contextually) but with a different format like, all the white spaces replaced by underscores (“_”), all the CamelCase form will be expanded by underscore (_) characters and it is always lower case.

There is also the code attribute which is simply the upper case form of nice_name if it is not defined differently (i.e set to another value).

notes

all the notes about this entity, it should be a list of Notes objects or an empty list, None is not accepted

tags

a list of Tag objects which shows the related tags to the entity

updated_by

The User who has updated this object.

print_resolution[source]

this is a property to set and get the print_resolution of the ImageFormat

  • it should be set to a positif non-zero float or integer
  • integers are also accepted but will be converted to float
  • for improper inputs the object will raise a ValueError