Skip to content
New: Star-import, signal unraveling, Python 3.12 support, and more

#
records module

Classes for working with allocation records.

## alloc_points_field_config ReadonlyConfig

Field config for AllocRanges.

    ReadonlyConfig(
        dtype=np.dtype([
            ('id', 'int64'),
            ('col', 'int64'),
            ('alloc_idx', 'int64')
        ]),
        settings=dict(
            idx=dict(
                name='alloc_idx'
            ),
            col=dict(
                title='Group',
                mapping='groups',
                group_indexing=True
            ),
            alloc_idx=dict(
                title='Allocation Index',
                mapping='index'
            )
        )
    )

## alloc_ranges_field_config ReadonlyConfig

Field config for AllocRanges.

    ReadonlyConfig(
        dtype=np.dtype([
            ('id', 'int64'),
            ('col', 'int64'),
            ('start_idx', 'int64'),
            ('end_idx', 'int64'),
            ('alloc_idx', 'int64'),
            ('status', 'int64')
        ]),
        settings=dict(
            idx=dict(
                name='alloc_idx'
            ),
            col=dict(
                title='Group',
                mapping='groups',
                group_indexing=True
            ),
            alloc_idx=dict(
                title='Allocation Index',
                mapping='index'
            )
        )
    )

## AllocPoints class

    AllocPoints(
        wrapper,
        records_arr,
        col_mapper=None,
        **kwargs
    )

Extends Ranges for working with allocation range records.

Superclasses

- Analyzable
- AttrResolverMixin
- Cacheable
- Chainable
- Comparable
- Configured
- ExtPandasIndexer
- HasSettings
- IndexingBase
- PandasIndexer
- Pickleable
- PlotsBuilderMixin
- Prettified
- Records
- RecordsWithFields
- StatsBuilderMixin
- Wrapping

Inherited members

- AttrResolverMixin.deep_getattr()
- AttrResolverMixin.post_resolve_attr()
- AttrResolverMixin.pre_resolve_attr()
- AttrResolverMixin.resolve_attr()
- AttrResolverMixin.resolve_shortcut_attr()
- Cacheable.get_ca_setup()
- Chainable.pipe()
- Configured.copy()
- Configured.equals()
- Configured.get_writeable_attrs()
- Configured.prettify()
- Configured.resolve_merge_kwargs()
- Configured.update_config()
- HasSettings.get_path_setting()
- HasSettings.get_path_settings()
- HasSettings.get_setting()
- HasSettings.get_settings()
- HasSettings.has_path_setting()
- HasSettings.has_path_settings()
- HasSettings.has_setting()
- HasSettings.has_settings()
- HasSettings.reset_settings()
- HasSettings.resolve_setting()
- HasSettings.resolve_settings_paths()
- HasSettings.set_settings()
- IndexingBase.indexing_setter_func()
- PandasIndexer.xs()
- Pickleable.decode_config()
- Pickleable.decode_config_node()
- Pickleable.dumps()
- Pickleable.encode_config()
- Pickleable.encode_config_node()
- Pickleable.file_exists()
- Pickleable.getsize()
- Pickleable.load()
- Pickleable.loads()
- Pickleable.modify_state()
- Pickleable.resolve_file_path()
- Pickleable.save()
- PlotsBuilderMixin.build_subplots_doc()
- PlotsBuilderMixin.override_subplots_doc()
- PlotsBuilderMixin.plots()
- Records.apply()
- Records.apply_mask()
- Records.build_field_config_doc()
- Records.cls_dir
- Records.col_arr
- Records.col_mapper
- Records.column_only_select
- Records.column_stack()
- Records.column_stack_records_arrs()
- Records.config
- Records.count()
- Records.coverage_map()
- Records.field_names
- Records.first_n()
- Records.get_apply_mapping_arr()
- Records.get_apply_mapping_str_arr()
- Records.get_column_stack_record_indices()
- Records.get_field_arr()
- Records.get_field_mapping()
- Records.get_field_name()
- Records.get_field_setting()
- Records.get_field_title()
- Records.get_map_field()
- Records.get_map_field_to_columns()
- Records.get_map_field_to_index()
- Records.get_pd_mask()
- Records.get_row_stack_record_indices()
- Records.group_select
- Records.has_conflicts()
- Records.id_arr
- Records.idx_arr
- Records.iloc
- Records.indexing_func()
- Records.indexing_func_meta()
- Records.indexing_kwargs
- Records.is_sorted()
- Records.last_n()
- Records.loc
- Records.map()
- Records.map_array()
- Records.map_field()
- Records.override_field_config_doc()
- Records.pd_mask
- Records.plots_defaults
- Records.prepare_customdata()
- Records.random_n()
- Records.range_only_select
- Records.rec_state
- Records.records
- Records.records_arr
- Records.records_readable
- Records.replace()
- Records.resample()
- Records.resample_meta()
- Records.resample_records_arr()
- Records.row_stack()
- Records.row_stack_records_arrs()
- Records.select_cols()
- Records.self_aliases
- Records.sort()
- Records.stats_defaults
- Records.to_readable()
- Records.values
- Records.wrapper
- Records.xloc
- StatsBuilderMixin.build_metrics_doc()
- StatsBuilderMixin.override_metrics_doc()
- StatsBuilderMixin.stats()
- Wrapping.regroup()
- Wrapping.resolve_column_stack_kwargs()
- Wrapping.resolve_row_stack_kwargs()
- Wrapping.resolve_self()
- Wrapping.resolve_stack_kwargs()
- Wrapping.select_col()
- Wrapping.select_col_from_obj()
- Wrapping.split()

### field_config class variable

Field config of AllocPoints.

    HybridConfig(
        dtype=np.dtype([
            ('id', 'int64'),
            ('col', 'int64'),
            ('alloc_idx', 'int64')
        ]),
        settings=dict(
            id=dict(
                name='id',
                title='Id',
                mapping='ids'
            ),
            col=dict(
                name='col',
                title='Group',
                mapping='groups',
                as_customdata=False,
                group_indexing=True
            ),
            idx=dict(
                name='alloc_idx',
                title='Index',
                mapping='index'
            ),
            alloc_idx=dict(
                title='Allocation Index',
                mapping='index'
            )
        )
    )

Returns `AllocPoints._field_config`, which gets (hybrid-) copied upon creation of each instance. Thus, changing this config won't affect the class.

To change fields, you can either change the config in-place, override this property, or overwrite the instance variable `AllocPoints._field_config`.

## AllocRanges class

    AllocRanges(
        wrapper,
        records_arr,
        open=None,
        high=None,
        low=None,
        close=None,
        **kwargs
    )

Extends Records for working with allocation point records.

Superclasses

- Analyzable
- AttrResolverMixin
- Cacheable
- Chainable
- Comparable
- Configured
- ExtPandasIndexer
- HasSettings
- IndexingBase
- PandasIndexer
- Pickleable
- PlotsBuilderMixin
- Prettified
- PriceRecords
- Ranges
- Records
- RecordsWithFields
- StatsBuilderMixin
- Wrapping

Inherited members

- AttrResolverMixin.deep_getattr()
- AttrResolverMixin.post_resolve_attr()
- AttrResolverMixin.pre_resolve_attr()
- AttrResolverMixin.resolve_attr()
- AttrResolverMixin.resolve_shortcut_attr()
- Cacheable.get_ca_setup()
- Chainable.pipe()
- Configured.copy()
- Configured.equals()
- Configured.get_writeable_attrs()
- Configured.prettify()
- Configured.resolve_merge_kwargs()
- Configured.update_config()
- HasSettings.get_path_setting()
- HasSettings.get_path_settings()
- HasSettings.get_setting()
- HasSettings.get_settings()
- HasSettings.has_path_setting()
- HasSettings.has_path_settings()
- HasSettings.has_setting()
- HasSettings.has_settings()
- HasSettings.reset_settings()
- HasSettings.resolve_setting()
- HasSettings.resolve_settings_paths()
- HasSettings.set_settings()
- IndexingBase.indexing_setter_func()
- PandasIndexer.xs()
- Pickleable.decode_config()
- Pickleable.decode_config_node()
- Pickleable.dumps()
- Pickleable.encode_config()
- Pickleable.encode_config_node()
- Pickleable.file_exists()
- Pickleable.getsize()
- Pickleable.load()
- Pickleable.loads()
- Pickleable.modify_state()
- Pickleable.resolve_file_path()
- Pickleable.save()
- PlotsBuilderMixin.build_subplots_doc()
- PlotsBuilderMixin.override_subplots_doc()
- PlotsBuilderMixin.plots()
- PriceRecords.from_records()
- PriceRecords.get_bar_close()
- PriceRecords.get_bar_close_time()
- PriceRecords.get_bar_high()
- PriceRecords.get_bar_low()
- PriceRecords.get_bar_open()
- PriceRecords.get_bar_open_time()
- PriceRecords.indexing_func()
- PriceRecords.indexing_func_meta()
- PriceRecords.resample()
- PriceRecords.resolve_column_stack_kwargs()
- PriceRecords.resolve_row_stack_kwargs()
- Ranges.avg_duration
- Ranges.bar_close
- Ranges.bar_close_time
- Ranges.bar_high
- Ranges.bar_low
- Ranges.bar_open
- Ranges.bar_open_time
- Ranges.close
- Ranges.cls_dir
- Ranges.col
- Ranges.col_arr
- Ranges.col_mapper
- Ranges.column_only_select
- Ranges.config
- Ranges.coverage
- Ranges.crop()
- Ranges.duration
- Ranges.end_idx
- Ranges.field_names
- Ranges.filter_max_duration()
- Ranges.filter_min_duration()
- Ranges.first_idx
- Ranges.first_pd_mask
- Ranges.from_array()
- Ranges.from_delta()
- Ranges.get_avg_duration()
- Ranges.get_coverage()
- Ranges.get_duration()
- Ranges.get_first_idx()
- Ranges.get_first_pd_mask()
- Ranges.get_invalid()
- Ranges.get_last_idx()
- Ranges.get_last_pd_mask()
- Ranges.get_max_duration()
- Ranges.get_projections()
- Ranges.get_ranges_pd_mask()
- Ranges.get_real_duration()
- Ranges.get_valid()
- Ranges.group_select
- Ranges.high
- Ranges.id
- Ranges.id_arr
- Ranges.idx_arr
- Ranges.iloc
- Ranges.indexing_kwargs
- Ranges.invalid
- Ranges.last_idx
- Ranges.last_pd_mask
- Ranges.loc
- Ranges.low
- Ranges.max_duration
- Ranges.open
- Ranges.overlap_coverage
- Ranges.pd_mask
- Ranges.plot()
- Ranges.plot_projections()
- Ranges.plot_shapes()
- Ranges.plots_defaults
- Ranges.projections
- Ranges.range_only_select
- Ranges.ranges_pd_mask
- Ranges.real_duration
- Ranges.rec_state
- Ranges.records
- Ranges.records_arr
- Ranges.records_readable
- Ranges.self_aliases
- Ranges.start_idx
- Ranges.stats_defaults
- Ranges.status
- Ranges.status_closed
- Ranges.status_open
- Ranges.valid
- Ranges.values
- Ranges.with_delta()
- Ranges.wrapper
- Ranges.xloc
- Records.apply()
- Records.apply_mask()
- Records.build_field_config_doc()
- Records.column_stack()
- Records.column_stack_records_arrs()
- Records.count()
- Records.coverage_map()
- Records.first_n()
- Records.get_apply_mapping_arr()
- Records.get_apply_mapping_str_arr()
- Records.get_column_stack_record_indices()
- Records.get_field_arr()
- Records.get_field_mapping()
- Records.get_field_name()
- Records.get_field_setting()
- Records.get_field_title()
- Records.get_map_field()
- Records.get_map_field_to_columns()
- Records.get_map_field_to_index()
- Records.get_pd_mask()
- Records.get_row_stack_record_indices()
- Records.has_conflicts()
- Records.is_sorted()
- Records.last_n()
- Records.map()
- Records.map_array()
- Records.map_field()
- Records.override_field_config_doc()
- Records.prepare_customdata()
- Records.random_n()
- Records.replace()
- Records.resample_meta()
- Records.resample_records_arr()
- Records.row_stack()
- Records.row_stack_records_arrs()
- Records.select_cols()
- Records.sort()
- Records.to_readable()
- StatsBuilderMixin.build_metrics_doc()
- StatsBuilderMixin.override_metrics_doc()
- StatsBuilderMixin.stats()
- Wrapping.regroup()
- Wrapping.resolve_self()
- Wrapping.resolve_stack_kwargs()
- Wrapping.select_col()
- Wrapping.select_col_from_obj()
- Wrapping.split()

### field_config class variable

Field config of AllocRanges.

    HybridConfig(
        dtype=np.dtype([
            ('id', 'int64'),
            ('col', 'int64'),
            ('start_idx', 'int64'),
            ('end_idx', 'int64'),
            ('alloc_idx', 'int64'),
            ('status', 'int64')
        ]),
        settings=dict(
            id=dict(
                name='id',
                title='Range Id',
                mapping='ids'
            ),
            col=dict(
                name='col',
                title='Group',
                mapping='groups',
                as_customdata=False,
                group_indexing=True
            ),
            idx=dict(
                name='alloc_idx',
                title='Index',
                mapping='index'
            ),
            start_idx=dict(
                title='Start Index',
                mapping='index'
            ),
            end_idx=dict(
                title='End Index',
                mapping='index'
            ),
            status=dict(
                title='Status',
                mapping=RangeStatusT(
                    Open=0,
                    Closed=1
                )
            ),
            alloc_idx=dict(
                title='Allocation Index',
                mapping='index'
            )
        )
    )

Returns `AllocRanges._field_config`, which gets (hybrid-) copied upon creation of each instance. Thus, changing this config won't affect the class.

To change fields, you can either change the config in-place, override this property, or overwrite the instance variable `AllocRanges._field_config`.

#### Cookie consent

We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.

- Google Analytics
- GitHub

Manage settings