SegmentsSuper#

class caf.base.data_structures.SegmentsSuper(value)[source]#

Bases: Enum

Getter for predefined segments.

This should be where segments forming segmentations come from. In most cases if a segment is not defined here it should be added, rather than defined as a custom segment in a Segmentation.

See also

Segments: for the full list of segment definitions.

Attributes

`PURPOSE`	See p in Data Definitions for details.
`TIMEPERIOD`	See tp in Data Definitions for details.
`MODE`	See m in Data Definitions for details.
`GENDER`	See g in Data Definitions for details.
`SOC`	See soc in Data Definitions for details.
`CA`	See ca in Data Definitions for details.
`USERCLASS`	See userclass in Data Definitions for details.
`ACCOMODATION_TYPE_H`	See accom_h in Data Definitions for details.
`ACCOMODATION_TYPE_HR`	See accom_hr in Data Definitions for details.
`ADULTS`	See adults in Data Definitions for details.
`CHILDREN`	See children in Data Definitions for details.
`CAR_AVAILABILITY`	See car_availability in Data Definitions for details.
`AGE`	See age_9 in Data Definitions for details.
`AGE_11`	See age_11 in Data Definitions for details.
`AGE_AGG`	See age_5 in Data Definitions for details.
`AGE_NTEM`	See age_ntem in Data Definitions for details.
`AGE_EDGE`	See age_edge in Data Definitions for details.
`GENDER_3`	See gender_3 in Data Definitions for details.
`ECONOMIC_STATUS`	See economic_status in Data Definitions for details.
`POP_EMP`	See pop_emp in Data Definitions for details.
`POP_ECON`	See pop_econ in Data Definitions for details.
`NS_SEC`	See ns_sec in Data Definitions for details.
`AWS`	See aws in Data Definitions for details.
`HH_TYPE`	See hh_type in Data Definitions for details.
`ADULT_NSSEC`	See adult_nssec in Data Definitions for details.
`SIC_1`	See sic_1_digit in Data Definitions for details.
`SIC_2`	See sic_2_digit in Data Definitions for details.
`SIC_4`	See sic_4_digit in Data Definitions for details.
`STATUS_APS`	See status_aps in Data Definitions for details.
`NORCOM_0V1`	See norcom_0v1+ in Data Definitions for details.
`TOTAL`	See total in Data Definitions for details.
`UNI`	See uni in Data Definitions for details.
`DIRECTION`	See direction in Data Definitions for details.
`DIRECTION_OD`	See direction_od in Data Definitions for details.

Methods

`values`()	Return values from class.
`get_segment`([subset])	Get a segment.

Attributes Documentation

PURPOSE = 'p'#: See p in Data Definitions for details.

TIMEPERIOD = 'tp'#: See tp in Data Definitions for details.

MODE = 'm'#: See m in Data Definitions for details.

GENDER = 'g'#: See g in Data Definitions for details.

SOC = 'soc'#: See soc in Data Definitions for details.

CA = 'ca'#: See ca in Data Definitions for details.

USERCLASS = 'userclass'#: See userclass in Data Definitions for details.

ACCOMODATION_TYPE_H = 'accom_h'#: See accom_h in Data Definitions for details.

ACCOMODATION_TYPE_HR = 'accom_hr'#: See accom_hr in Data Definitions for details.

ADULTS = 'adults'#: See adults in Data Definitions for details.

CHILDREN = 'children'#: See children in Data Definitions for details.

CAR_AVAILABILITY = 'car_availability'#: See car_availability in Data Definitions for details.

AGE = 'age_9'#: See age_9 in Data Definitions for details.

AGE_11 = 'age_11'#: See age_11 in Data Definitions for details.

AGE_AGG = 'age_5'#: See age_5 in Data Definitions for details.

AGE_NTEM = 'age_ntem'#: See age_ntem in Data Definitions for details.

AGE_EDGE = 'age_edge'#: See age_edge in Data Definitions for details.

GENDER_3 = 'gender_3'#: See gender_3 in Data Definitions for details.

ECONOMIC_STATUS = 'economic_status'#: See economic_status in Data Definitions for details.

POP_EMP = 'pop_emp'#: See pop_emp in Data Definitions for details.

POP_ECON = 'pop_econ'#: See pop_econ in Data Definitions for details.

NS_SEC = 'ns_sec'#: See ns_sec in Data Definitions for details.

AWS = 'aws'#: See aws in Data Definitions for details.

HH_TYPE = 'hh_type'#: See hh_type in Data Definitions for details.

ADULT_NSSEC = 'adult_nssec'#: See adult_nssec in Data Definitions for details.

SIC_1 = 'sic_1_digit'#: See sic_1_digit in Data Definitions for details.

SIC_2 = 'sic_2_digit'#: See sic_2_digit in Data Definitions for details.

SIC_4 = 'sic_4_digit'#: See sic_4_digit in Data Definitions for details.

STATUS_APS = 'status_aps'#: See status_aps in Data Definitions for details.

NORCOM_0V1 = 'norcom_0v1+'#: See norcom_0v1+ in Data Definitions for details.

TOTAL = 'total'#: See total in Data Definitions for details.

UNI = 'uni'#: See uni in Data Definitions for details.

DIRECTION = 'direction'#: See direction in Data Definitions for details.

DIRECTION_OD = 'direction_od'#: See direction_od in Data Definitions for details.