BaseCoordinateFrame

class astropy.coordinates.BaseCoordinateFrame(*args, copy=True, representation_type=None, differential_type=None, **kwargs)[ソース]

ベースクラス: astropy.utils.shapes.ShapedLikeNDArray

座標枠の基底類。

このようなものは、特定のシステムのインスタンスを作成するためにサブクラス化されることが意図サブクラスは以下の属性を実現することができる.

  • default_representation

    の子類 BaseRepresentation これは、このフレームのデフォルト表現形式とみなされるであろう。これは,フレームワークを作成する際にデフォルトで採用されている表示形式である.

  • default_differential

    の子類 BaseDifferential これは、このフレームのデフォルト差分分類とみなされる。これは,フレームを作成する際にデフォルトで採用される差分クラスである.

  • Attribute 類属性.

    フレームワーク属性、例えば FK4.equinox あるいは…。 FK4.obstime 記述子クラスを用いて定義される.詳細については、記述文書または内蔵クラスコードを参照されたい。

  • frame_specific_representation_info

    表示された名前またはクラスをリストの辞書にマッピングする RepresentationMapping オブジェクト,これらのオブジェクトは,このフレームワーク上でその表現されたコンポーネントのためにどのような名前とデフォルト単位を使用すべきかを教える.

通過しない限り frame_specific_representation_info 速度名のデフォルト値は:

どこだ? {{lon}} そして {{lat}} 角度コンポーネントのフレーム名である.

パラメータ
dataBaseRepresentation サブクラス事例BasePresationサブクラス事例

対象を表すか None データがない場合(または座標コンポーネントパラメータを使用する場合は、以下参照)。

*args, ** コバルガス

協調コンポーネントは,その名前はサブクラスに依存する.

representation_typeBaseRepresentation サブクラス、文字列、オプションBasePresationサブクラス、文字列、オプション

クラスまたはクラスを表す文字列名.これは、入力データの予期されるキーワードパラメータを変更するために、予期される入力表示クラスを設定する。例えば伝達は representation_type='cartesian' クラスにデカルト名を持たせる位置データ,すなわち x, y, z ほとんどの場合通過しない限り frame_specific_representation_info それがそうです。このフレームワークの名前を表示するには、表示してください <this frame>().representation_info それがそうです。

differential_typeBaseDifferential サブクラス、文字列、辞書、オプションBaseDifferentialクラス、文字列、dict、オプション

差分類または差分類辞書(現在はキーワード‘s’付き速度差のみをサポートしている).これは、入力されたデータの予期されるキーワードパラメータを変更するために、予想される入力差分クラスを設定する。例えば伝達は differential_type='cartesian' クラスにパラメータ名を持たせる速度データを期待する. v_x, v_y, v_z 通過しない限り frame_specific_representation_info それがそうです。このフレームワークの名前を表示するには、表示してください <this frame>().representation_info それがそうです。

copyブル値、オプション

もし True (デフォルト),入力座標配列をコピーする.キーワードパラメータとしてしか入力できない.

属性要約

cache \

このフレームのキャッシュは、辞書です。これは、座標データから計算すべきすべてのコンテンツを格納する( not フレーム属性から)。これは、任意の計算コストが高いが、他の関数によって再使用される可能性のあるコンテンツを格納するために関数において使用されることができる。例::.

cartesian \

この対象における座標のデカルトで表される速記.

cylindrical \

この対象における座標の柱面で表される速記.

data \

この対象の座標データ.

default_differential \

default_representation \

differential_type \

このフレームデータの差分値に使用される。

frame_attributes \

frame_specific_representation_info \

has_data \

もしこのフレームが data そうでなければFalseである.

isscalar \

proper_motion \

2次元自然運動の速記は Quantity 角速度単位を持つオブジェクト.

radial_velocity \

半径方向や視線速度の速記形式は Quantity 物体です。

representation \

representation_component_names \

representation_component_units \

representation_info \

このフレームのどの属性名が特定の表現情報に適用されるかを含む辞書。

representation_type \

このフレームデータに用いられる表現クラス。

shape \

基礎データの形状。

size \

対象形状から計算される対象サイズ.

spherical \

このオブジェクトにおける座標の球面表現の速記.

sphericalcoslat \

位置データの球面表現の略字形式と SphericalCosLatDifferential このオブジェクト中の速度データ.

velocity \

デカルト空間運動を CartesianDifferential 物体です。

方法要約

get_frame_attr_names \()

get_representation_cls \([which] )

このフレームに使用される部分データのクラス。

get_representation_component_names \([which] )

get_representation_component_units \([which] )

is_equivalent_frame \(その他)

この対象があるかどうかをチェックします other 物体です。

is_frame_attr_default \(プロパティ)

デフォルト値であるので、フレームワーク属性にその値があるかどうかを決定する、またはこのフレームワークは明示的な要求の値を使用して作成されるからである。

is_transformable_to \(新規_フレームワーク)

この座標フレームを別の所与のフレームに変換することができるか否かが判断される。

realize_frame \(データ,** Kwargs)

新しいフレームは、別のフレーム(データがある場合もあれば、データもない場合もある)からの新しいデータを使用して生成される。

replicate \([copy] )

フレームのコピーに戻り,新たなフレーム属性を使用することを選択することができる.

replicate_without_data \([copy] )

データを有しないコピーを返し、新しいフレーム属性を有することを選択してもよい。

represent_as \(基礎[, s, in_frame_units] )

このフレームの新しい表現形式を生成して返す data 表示対象とする。

separation \(その他)

この座標と他方の座標との間の空間隔を計算する。

separation_3d \(その他)

この座標と他方の座標との3次元間隔を算出する。

set_representation_cls \([base, s] )

このフレームデータの表現および/または差分カテゴリを設定する。

transform_to \(新規_フレームワーク)

このオブジェクトの座標データを新しいフレームに変換する.

属性文書

cache

このフレームのキャッシュは、辞書です。これは、座標データから計算すべきすべてのコンテンツを格納する( not フレーム属性から)。これは、任意の計算コストが高いが、他の関数によって再使用される可能性のあるコンテンツを格納するために関数において使用されることができる。例えば:

if 'user_data' in myframe.cache:
    data = myframe.cache['user_data']
else:
    myframe.cache['user_data'] = data = expensive_func(myframe.lat)

フレームデータが定位置修正された場合、キャッシュはクリアされるべきである:

myframe.cache.clear()
cartesian

この対象における座標のデカルトで表される速記.

cylindrical

この対象における座標の柱面で表される速記.

data

この対象の座標データ.このフレームにデータがなければ ValueError 育てられます。使用 has_data このフレームワークオブジェクトにデータが存在するかどうかをチェックするには,以下の操作を実行してください.

default_differential = None
default_representation = None
differential_type

このフレームデータの差分値に使用される。

これはサブクラスから来たものになります BaseDifferential それがそうです。表示法と差分値の同時設定に関する情報は、参照されたい set_represenation_cls 方法です。

frame_attributes = {}
frame_specific_representation_info = {<class 'astropy.coordinates.representation.SphericalRepresentation'>: [RepresentationMapping(reprname='lon', framename='lon', defaultunit='recommended'), RepresentationMapping(reprname='lat', framename='lat', defaultunit='recommended')], <class 'astropy.coordinates.representation.SphericalCosLatDifferential'>: [RepresentationMapping(reprname='d_lon_coslat', framename='pm_lon_coslat', defaultunit=Unit("mas / yr")), RepresentationMapping(reprname='d_lat', framename='pm_lat', defaultunit=Unit("mas / yr")), RepresentationMapping(reprname='d_distance', framename='radial_velocity', defaultunit=Unit("km / s"))], <class 'astropy.coordinates.representation.SphericalDifferential'>: [RepresentationMapping(reprname='d_lon', framename='pm_lon', defaultunit=Unit("mas / yr")), RepresentationMapping(reprname='d_lat', framename='pm_lat', defaultunit=Unit("mas / yr")), RepresentationMapping(reprname='d_distance', framename='radial_velocity', defaultunit=Unit("km / s"))], <class 'astropy.coordinates.representation.CartesianDifferential'>: [RepresentationMapping(reprname='d_x', framename='v_x', defaultunit=Unit("km / s")), RepresentationMapping(reprname='d_y', framename='v_y', defaultunit=Unit("km / s")), RepresentationMapping(reprname='d_z', framename='v_z', defaultunit=Unit("km / s"))], <class 'astropy.coordinates.representation.UnitSphericalRepresentation'>: [RepresentationMapping(reprname='lon', framename='lon', defaultunit='recommended'), RepresentationMapping(reprname='lat', framename='lat', defaultunit='recommended')], <class 'astropy.coordinates.representation.UnitSphericalCosLatDifferential'>: [RepresentationMapping(reprname='d_lon_coslat', framename='pm_lon_coslat', defaultunit=Unit("mas / yr")), RepresentationMapping(reprname='d_lat', framename='pm_lat', defaultunit=Unit("mas / yr")), RepresentationMapping(reprname='d_distance', framename='radial_velocity', defaultunit=Unit("km / s"))], <class 'astropy.coordinates.representation.UnitSphericalDifferential'>: [RepresentationMapping(reprname='d_lon', framename='pm_lon', defaultunit=Unit("mas / yr")), RepresentationMapping(reprname='d_lat', framename='pm_lat', defaultunit=Unit("mas / yr")), RepresentationMapping(reprname='d_distance', framename='radial_velocity', defaultunit=Unit("km / s"))]}
has_data

もしこのフレームが data そうでなければFalseである.

isscalar
proper_motion

Shorthand for the two-dimensional proper motion as a Quantity object with angular velocity units. In the returned Quantity, axis=0 is the longitude/latitude dimension so that .proper_motion[0] is the longitudinal proper motion and .proper_motion[1] is latitudinal. The longitudinal proper motion already includes the cos(latitude) term.

radial_velocity

半径方向や視線速度の速記形式は Quantity 物体です。

representation
representation_component_names
representation_component_units
representation_info

このフレームのどの属性名が特定の表現情報に適用されるかを含む辞書。

representation_type

このフレームデータに用いられる表現クラス。

これはサブクラスから来たものになります BaseRepresentation それがそうです。そうでもいい set 表示された文字列名を用いる.明示的な差分クラス(推定されるのではなく)を設定したい場合は、使用してください set_represenation_cls 方法です。

shape
size
spherical

このオブジェクトにおける座標の球面表現の速記.

sphericalcoslat

位置データの球面表現の略字形式と SphericalCosLatDifferential このオブジェクト中の速度データ.

velocity

デカルト空間運動を CartesianDifferential 相手。これは呼び出しに相当する self.cartesian.differentials['s'] それがそうです。

方法文書

classmethod get_frame_attr_names()[ソース]
get_representation_cls(which='base')[ソース]

このフレームに使用される部分データのクラス。

パラメータ
どっち? :(‘base’,‘s’, None(‘base’,‘s’,

戻る部分のクラスです。Base‘は、座標を表すためのクラスを意味し、’s‘は、時間の一次微分係数、すなわち、自己および/または半径方向速度を表すクラスである。もし…。 None 両方を1つの辞書に戻します

返品
表示法BaseRepresentation あるいは…。 BaseDifferential それがそうです。BasePresationやBaseDifferentialである.
get_representation_component_names(which='base')[ソース]
get_representation_component_units(which='base')[ソース]
is_equivalent_frame(other)[ソース]

この対象があるかどうかをチェックします other 物体です。

同じフレームワークとなるためには,2つのオブジェクトは同じフレームクラスであり,同じフレーム属性を持つ必要がある.これは確かにそうしていることに注意してください。 not 重要なのは,どのオブジェクトにもどのようなデータがあるか(あれば)である.

パラメータ
他にも : BaseCoordinateFrameBaseCoordinateFrame

検査する別のフレーム

返品
isequivブルル.

フレームが同じであればTrue,異なる場合はFalseとなる.

賃上げをする
TypeError

もし other 一つではない BaseCoordinateFrame あるいはサブクラスです

is_frame_attr_default(attrnm)[ソース]

デフォルト値であるので、フレームワーク属性にその値があるかどうかを決定する、またはこのフレームワークは明示的な要求の値を使用して作成されるからである。

パラメータ
attrnm応力.応力

チェックする属性の名前。

返品
isdefaultブルル.

属性がTrueであればTrueとなる. attrnm デフォルトの場合はその値を持ち,このフレームを作成する際に指定された場合はfalseとなる.

is_transformable_to(new_frame)[ソース]

この座標フレームを別の所与のフレームに変換することができるか否かが判断される。

パラメータ
new_frameBaseCoordinateFrame サブクラスまたはインスタンスBaseOrganateFrameクラスまたはインスタンス

変換するためのアドバイスフレームワーク。

返品
transformableブールまたは文字列

True if this can be transformed to new_frame, False if not, or the string 'same' if new_frame is the same system as this object but no transformation is defined.

注意事項

返却値“Same”は、変換が機能することを示すが、そのオブジェクトのコピーのみが返される。期待される用途は

if coord.is_transformable_to(some_unknown_frame):
    coord2 = coord.transform_to(some_unknown_frame)

これは効果があります some_unknown_frame 同じFrame類だったのですが coord それがそうです。これは、フレーム属性(例えば、ICR)にかかわらずフレームが同じ場合に適用されるが、注意されたい。 できる限りのことをする また,同一のFrameクラスを定義することを忘れているが異なる属性を持つ2つのオブジェクト間の変換を表す.

realize_frame(data, **kwargs)[ソース]

新しいフレームは、別のフレーム(データがある場合もあれば、データもない場合もある)からの新しいデータを使用して生成される。大ざっぱに言えばそれとは逆に replicate_without_data それがそうです。

パラメータ
dataBaseRepresentationBaseRepresentation

新しいフレームワークデータの表示形式として用いる.

他のキーワードは
new frame object. In particular, `representation_type` can be specified.
返品
フレームオブジェクト.BaseCoordinateFrame サブクラス事例BaseOrganateFrameクラスのインスタンス

中の新しい対象 this フレームワークは,このフレームワークと同じフレームワーク属性を持つが, data 座標データとする.

replicate(copy=False, **kwargs)[ソース]

フレームのコピーに戻り,新たなフレーム属性を使用することを選択することができる.

コピーは、このFrameオブジェクトと同じデータを有する新しいFrameオブジェクトであり、Frame属性が追加のキーワードパラメータとしてこの方法に提供される場合、これらの属性は上書きされる。もし…。 copy とする. True そして内部配列のコピーを作成する.そうでなければ、コピーは、メモリを節約するために、可能な場合に元の配列への参照を使用するであろう。ユーザは通常内部配列を変更することができないため,多くの場合設定する必要がない. copy 至る True それがそうです。

パラメータ
copyブル値、オプション

Trueであれば,生成されるオブジェクトはデータのコピーである.Falseであれば,可能な場合には参照を用いる.このルールはフレームワーク属性にも適用される.

他のキーワードは
フレームワークオブジェクトを新規作成する.
返品
フレームオブジェクト.BaseCoordinateFrame サブクラス事例BaseOrganateFrameクラスのインスタンス

このオブジェクトのコピーは、新しいフレーム属性を有する可能性がある。

replicate_without_data(copy=False, **kwargs)[ソース]

データを有しないコピーを返し、新しいフレーム属性を有することを選択してもよい。

コピーは新しいFrameオブジェクトであり、データはないが、この方法の追加のキーワードパラメータによってカバーされない限り、このオブジェクトと同じFrame属性を有する。♪the copy キーワードは、参照されるのではなく、フレーム属性が本当にコピーされているかどうかを決定する(これは、フレーム属性が大きい場合にメモリを節約する)。

この方法は本質的に realize_frame それがそうです。

パラメータ
copyブル値、オプション

Trueであれば,生成されたオブジェクトはフレーム属性のコピーを持つ.Falseであれば,可能な場合には参照を用いる.

他のキーワードは
フレームワークオブジェクトを新規作成する.
返品
フレームオブジェクト.BaseCoordinateFrame サブクラス事例BaseOrganateFrameクラスのインスタンス

このオブジェクトのコピーは、データがないが、新しいフレーム属性を有する可能性がある。

represent_as(base, s='base', in_frame_units=False)[ソース]

このフレームの新しい表現形式を生成して返す data 表示対象とする。

注意:FrameやSkyCoordオブジェクトの表示形式をその場で変更するために、 representation 属性は、必要な新しい表現形式に設定したり、使用したりします。 set_representation_cls 方法は差分を設定することも可能である.

パラメータ
baseBasePresationまたはStringのサブクラス

生成する表示のタイプ.1つでなければならない クラス (インスタンスではない)またはクラスを表す文字列名。

s :の子類 BaseDifferential 文字列、オプションの子類

その中で任意の速度のクラスを表すべきである.1つでなければならない クラス (インスタンスではありません)または差分クラスの文字列名です。‘base’(デフォルト値)に等しい場合は,基底クラスから推定する.もし…。 None すべての速度情報を破棄する.

in_frame_unitsブール値はキーワードだけです

強制グラフィックス表現単位は,このフレームに特定された指定単位と一致する.

返品
newrepBasePresation-派生オブジェクト

このフレームの新しい表示オブジェクト data それがそうです。

賃上げをする
AttributeError

もしこの相手がいなければ data

実例.

>>> from astropy import units as u
>>> from astropy.coordinates import SkyCoord, CartesianRepresentation
>>> coord = SkyCoord(0*u.deg, 0*u.deg)
>>> coord.represent_as(CartesianRepresentation)  
<CartesianRepresentation (x, y, z) [dimensionless]
        (1., 0., 0.)>
>>> coord.representation_type = CartesianRepresentation
>>> coord  
<SkyCoord (ICRS): (x, y, z) [dimensionless]
    (1., 0., 0.)>
separation(other)[ソース]

この座標と他方の座標との間の空間隔を計算する。

注釈

もし other 座標オブジェクトは異なるフレームに位置し,まずそのオブジェクトのフレームを変換する.これを考慮しないと,直感的でない行動を招く可能性がある.特筆すべきは self.separation(other) そして other.separation(self) この場合、同じ答えが与えられないかもしれない。

パラメータ
他にもBaseCoordinateFrameBaseCoordinateFrame

分離した座標を設定する.

返品
sepAngle角を挟む.

この点とこの2つの線の間の空の距離は other 座標です。

注意事項

分離はVincenty式を用いて計算され,両極と対極を含むすべての位置で安定している. [1].

1

https://en.wikipedia.org/wiki/Great-circle_distance

separation_3d(other)[ソース]

この座標と他方の座標との3次元間隔を算出する。

パラメータ
他にもBaseCoordinateFrameBaseCoordinateFrame

距離の座標系を得る.

返品
sepDistance距離

この2つの座標間の実空間距離。

賃上げをする
ValueError

この座標または他の座標に距離がなければ。

set_representation_cls(base=None, s='base')[ソース]

このフレームデータの表現および/または差分カテゴリを設定する。

パラメータ
base :str、 BaseRepresentation サブクラス、オプション文字列は

座標データを表すための名前またはサブクラス。

sBaseDifferential サブクラス、オプションBaseDifferentialクラス、オプション

任意の速度(例えば、自己速度および半径方向速度)を表すためのマイクロ分子クラス。デフォルトの‘base’に等しい場合は,表示から推定する.もし…。 None すなわち,どのような差異も破棄されることを表す.

transform_to(new_frame)[ソース]

このオブジェクトの座標データを新しいフレームに変換する.

パラメータ
new_frame :類似座標または BaseCoordinateFrame サブクラス事例クラス座標または

この座標フレームをフレームに変換する.Frameクラスのオプションはすでに使用されていない.

返品
transframeクラス座標.

コントロール中の座標データを表す新しいオブジェクト newframe システム(表示 SkyCoord まだSkyCoordになるだろう)。

賃上げをする
ValueError

可能な変換経路がなければ。