CoordinateHelper#
- class astropy.visualization.wcsaxes.CoordinateHelper(parent_axes=None, parent_map=None, transform=None, coord_index=None, coord_type='scalar', coord_unit=None, coord_wrap=None, frame=None, format_unit=None, default_label=None)[源代码]#
基类:
object
类来控制
WCSAxes
.- 参数:
- parent_axes :
WCSAxes
WCSAxes
坐标辅助对象所属的轴。
- parent_map :
CoordinatesMap
CoordinatesMap
这个
CoordinatesMap
此坐标所属的对象。- 转型 :
Transform
变换 对应于这个坐标系的变换。
- coord_index :
int
Python :整型 中此坐标的索引
CoordinatesMap
.- coord_type{'经度','纬度','标量'}
此坐标的类型,用于确定坐标的换行和边界行为。经度在
coord_wrap
,纬度必须在-90到90的范围内,标量是无限的,不缠绕。- coord_unit :
Unit
单位 给定变换输出时,坐标所在的单位。
- format_unit :
Unit
可选单元,可选 用于显示坐标的单位。
- coord_wrap :
astropy.units.Quantity
astropy.units.Quantity
经度换行的角度(默认为360度)。
- 框架 :
BaseFrame
BaseFrame
框架
WCSAxes
.
- parent_axes :
属性摘要
方法总结
add_tickable_gridline
(name, constant)定义可用于记号和标签的网格线。
display_minor_ticks
(display_minor_ticks)显示此坐标的次要刻度。
format_coord
(value[, format])给定一个坐标的值,将根据格式设置程序定位器的格式对其进行格式化。
如果未提供显式标签,则呈现默认轴标签。
get_axislabel
\()获取轴标签的文本。
获取用于确定何时绘制轴标签的规则。
get_format_unit
\()获取主要刻度标签的单位。
grid
([draw_grid, grid_type])为此坐标绘制网格线。
set_auto_axislabel
(auto_label)如果未提供显式标签,则呈现默认轴标签。
set_axislabel
(text[, minpad])设置轴标签的文本和可选的视觉特性。
set_axislabel_position
\(位置)设置轴标签应显示的位置。
设置用于确定何时绘制轴标签的规则。
set_coord_type
(coord_type[, coord_wrap])设置轴的坐标类型。
set_format_unit
(unit[, decimal, ...])设置主要刻度标签的单位。
set_major_formatter
\(格式化程序)设置用于主要刻度标签的格式设置工具。
set_minor_frequency
\(频率)设置每个主刻度的次刻度频率。
set_separator
\(分隔符)设置用于角度主刻度标签的分隔符。
set_ticklabel
([color, size, pad, ...])设置记号标签的视觉特性。
set_ticklabel_position
\(位置)设置刻度线标签应显示的位置。
set_ticklabel_visible
\(可见)设置记号标签是否可见。
set_ticks
([values, spacing, number, size, ...])设置记号的位置和属性。
set_ticks_position
\(位置)设置刻度线应出现的位置。
set_ticks_visible
\(可见)设置记号是否可见。
tick_params
([which])方法设置tick和tick label参数的方法与
tick_params()
Matplotlib中的方法。属性文档
- formatter#
- locator#
方法文件
- add_tickable_gridline(name, constant)[源代码]#
定义可用于记号和标签的网格线。
此网格线本身不是绘制的,而是可以在调用方法(如
set_ticklabel_position()
用于绘制记号和标签。由于网格线在此坐标中具有常量值,因此同一坐标不会有任何刻度或标签,因此调用set_ticklabel_position()
通常是在互补坐标上进行的。笔记
限制是网格线的可勾选部分必须是连续的。如果网格线在打印范围内包含多条断开连接的线段,则这些线段中只有一条是可勾选的。
- display_minor_ticks(display_minor_ticks)[源代码]#
显示此坐标的次要刻度。
- 参数:
- display_minor_ticks : bool布尔
是否显示次要刻度。
- format_coord(value, format='auto')[源代码]#
给定一个坐标的值,将根据格式设置程序定位器的格式对其进行格式化。
- 参数:
- value :
float
Python :浮点 要格式化的值
- format{'auto','ascii','latex'},可选
要使用的格式-默认情况下,格式将根据Matplotlib是使用LaTeX还是MathTex进行调整。要获取纯ASCII字符串,请使用format='ASCII'。
- value :
- grid(draw_grid=True, grid_type=None, **kwargs)[源代码]#
为此坐标绘制网格线。
标准matplotlib外观选项(color、alpha等)可以作为关键字参数传递。
- 参数:
- draw_grid : bool布尔
是否显示网格线
- grid_type{'线','轮廓'}
是否通过在世界坐标系中确定栅格线,然后在世界坐标系中绘制等高线 (
'lines'
)或者通过确定图像中许多位置的世界坐标,然后绘制轮廓 ('contours'
). 第一个建议用于二维图像,而对于三维(或更高维)立方体,则'contours'
建议选择。默认情况下,如果变换具有反转,则使用“直线”,否则使用“轮廓”。
- set_axislabel(text, minpad=1, **kwargs)[源代码]#
设置轴标签的文本和可选的视觉特性。
- 参数:
- text :
str
Python :字符串 轴标签文本。
- minpad :
float
,可选Python:Float,可选 以轴标签字体大小表示的标签填充。
- **kwargs
关键字传递给
matplotlib.text.Text
. 这些可以包括关键字来设置color
,size
,weight
,以及其他文本属性。
- text :
- set_axislabel_position(position)[源代码]#
设置轴标签应显示的位置。
- 参数:
- position :
str
Python :字符串 应显示此坐标的轴标签的轴。应该是一个包含零个或多个
'b'
,'t'
,'l'
,'r'
. 例如,'lb'
将引导轴标签显示在左下轴上。
- position :
- set_axislabel_visibility_rule(rule)[源代码]#
设置用于确定何时绘制轴标签的规则。
- 参数:
- rule :
str
Python :字符串 如果规则为“始终”,轴标签将始终绘制在轴上。如果规则为“记号”,则只有在该轴上绘制记号时才会绘制标签。如果规则为“标签”,则只有在坐标轴上绘制刻度标签时才会绘制坐标轴标签。
- rule :
- set_ticklabel(color=None, size=None, pad=None, exclude_overlapping=None, **kwargs)[源代码]#
设置记号标签的视觉特性。
- set_ticklabel_position(position)[源代码]#
设置刻度线标签应显示的位置。
- 参数:
- position :
str
Python :字符串 应显示此坐标的刻度标签的轴。应该是一个包含零个或多个
'b'
,'t'
,'l'
,'r'
. 例如,'lb'
将引导刻度标签显示在左下轴上。
- position :
- set_ticks(values=None, spacing=None, number=None, size=None, width=None, color=None, alpha=None, direction=None, exclude_overlapping=None)[源代码]#
设置记号的位置和属性。
最多有一个选项来自
values
,spacing
或number
可以指定。- 参数:
- values : iterable ,可选Python:可迭代,可选
显示刻度的坐标值。
- spacing :
float
,可选Python:Float,可选 刻度之间的间距。
- number :
float
,可选Python:Float,可选 显示的大约刻度数。
- size :
float
,可选Python:Float,可选 刻度的长度(以点为单位)
- color :
str
或tuple
,可选PYTHON:字符串或PYTHON:元组,可选 记号的有效Matplotlib颜色
- alpha :
float
,可选Python:Float,可选 记号的alpha值(透明度)。
- direction{'in','out'},可选
蜱虫应该向内还是向外。
- set_ticks_position(position)[源代码]#
设置刻度线应出现的位置。
- 参数:
- position :
str
Python :字符串 应显示此坐标的刻度的轴。应该是一个包含零个或多个
'b'
,'t'
,'l'
,'r'
. 例如,'lb'
将引导记号显示在左下轴上。
- position :
- tick_params(which='both', **kwargs)[源代码]#
方法设置tick和tick label参数的方法与
tick_params()
Matplotlib中的方法。这是为了方便起见而提供的,但建议使用API
set_ticks()
,set_ticklabel()
,set_ticks_position()
,set_ticklabel_position()
和grid()
.- 参数:
- which{'both','major','minor'},可选
将设置应用到的刻度。默认情况下,设置同时应用于主刻度和次刻度。注意如果
'minor'
则当前只能设置刻度的长度。- direction{'in','out'},可选
将记号放在轴内或轴外。
- length :
float
,可选Python:Float,可选 以点为单位的刻度长度。
- width :
float
,可选Python:Float,可选 以点为单位的刻度宽度。
- color : color ,可选颜色,可选
记号颜色(接受任何有效的Matplotlib颜色)
- pad :
float
,可选Python:Float,可选 刻度线和标签之间的点距离。
- labelsize :
float
或str
,可选PYTHON:FLOAT或PYTHON:STR,可选 以点或字符串(例如“大”)标记标签字体大小。
- labelcolor : color ,可选颜色,可选
接受任何颜色库颜色标签
- colors : color ,可选颜色,可选
- 将记号颜色和标签颜色更改为相同的值
(接受任何有效的Matplotlib颜色)。
- bottom, top, left, right : bool ,可选可选的布尔
在哪里画记号。请注意,如果框架不是矩形的,这将无法正常工作。
- labelbottom, labeltop, labelleft, labelright : bool ,可选可选的布尔
在哪里绘制记号标签。请注意,如果框架不是矩形的,这将无法正常工作。
- grid_color : color ,可选颜色,可选
网格线的颜色(接受任何有效的Matplotlib颜色)。
- grid_alpha :
float
,可选Python:Float,可选 网格线的透明度:0(透明)到1(不透明)。
- grid_linewidth :
float
,可选Python:Float,可选 网格线的宽度(以点为单位)。
- grid_linestyle :
str
,可选Python:字符串,可选 网格线的样式(接受任何有效的Matplotlib线样式)。