<--
SAMP MTypesThis page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients.IntroductionAn MType (Message Type) is the semantic label attached to a SAMP message (see SampInfo). An MType is a string which looks syntactically likea.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard. | ||||||||
Changed: | ||||||||
< < | MTypes fall into (about) three categories: | |||||||
> > | MTypes fall into (about) four categories: | |||||||
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines:
Application MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format. This is the usual way to exchange table data between SAMP clients.
table.load.*Othertable.load variants are permitted for different formats. The parameters and return value are the same as for table.load.votable above, but the resource referenced by the url argument has the appropriate file format.
Variants known to be in use are:
table.load.votable and not other table.load.* variants. However, where clients need to exchange tabular data in a particular format, for instance because both ends of the communication are known to understand the format in question, or because the data or metadata are likely to be compromised by conversion to VOTable, use of a different format-specific MType may be appropriate, on the understanding that such communication may not be interoperable with generic table-handling SAMP clients.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
spectrum.load.ssa-genericLoads a spectrum or SED. The name refers to the fact that the metadata passed with this MType is based on the Simple Spectral Access protocol, but not on any particular version of it. The arguments are chosen such that it is convenient to use this MType for passing the results of an SSA query from an SSA client to a spectrum viewer (particularly to an SSA-capable spectrum viewer). However it is not necessary for SSA to be involved; SSA-like metadata may be faked and used to message loading of a spectrum from any source. In the latter case it is RECOMMENDED to provide at least theAccess.Format entry in the meta map.
client.env.getReturns the value of an environment variable present in the environment of the receiver client.
bibcode.loadExchange a bibcode:
voresource.loadlist (and subtypes)Exchange a set of vo registry resources. A registry resource is described by an xml document - a VOResource . Each registry resource is uniquely identified by a IVOID - a uri startingivo://
ids map are a convenience for receivers who may not possess a SOAP Registry client with which to retrieve the voresources themself. The URLs may also be useful in the case where the resource is only available in registry private to the sender, not in a registry known by the receiver.
However, the URL values are not mandatory, because to implement this, it may be necessary for the sender to create a local web-server - which is quite a demand for, say, a trivial script.
If the registry spec ever develops to provide a trival http / rest interface to resources, the URL values could link direct to this - but at the moment it's a work-around for the relative inaccessability of the registry SOAP interface.
coverage.load.moc.fitsLoad a Multi-Order Coverage map in FITS format. MOCs and their FITS serialization are described in the MOC standard. FITS is the standard exchange format for MOCs - the introduction of alternative MOC load MTypes is not encouraged.
Experimental Administrative MTypesx-samp.query.by-metaQueries which clients are currently registered with a given metadata value. A typical use would be to query which client(s) is currently registered with a givensamp.name , so for instance you could find the client ID of a registered Aladin instance
by calling this MType with key="samp.name" and value="Aladin".
This is effectively a convenience method for interrogating the metadata currently available
from the Hub, and so could typically be implemented by the Hub,
but there is nothing to stop a client from implementing it too.
|
<--
SAMP MTypesThis page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients.IntroductionAn MType (Message Type) is the semantic label attached to a SAMP message (see SampInfo). An MType is a string which looks syntactically likea.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard.
MTypes fall into (about) three categories:
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines:
Application MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format. This is the usual way to exchange table data between SAMP clients.
table.load.*Othertable.load variants are permitted for different formats. The parameters and return value are the same as for table.load.votable above, but the resource referenced by the url argument has the appropriate file format.
Variants known to be in use are:
table.load.votable and not other table.load.* variants. However, where clients need to exchange tabular data in a particular format, for instance because both ends of the communication are known to understand the format in question, or because the data or metadata are likely to be compromised by conversion to VOTable, use of a different format-specific MType may be appropriate, on the understanding that such communication may not be interoperable with generic table-handling SAMP clients.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
spectrum.load.ssa-genericLoads a spectrum or SED. The name refers to the fact that the metadata passed with this MType is based on the Simple Spectral Access protocol, but not on any particular version of it. The arguments are chosen such that it is convenient to use this MType for passing the results of an SSA query from an SSA client to a spectrum viewer (particularly to an SSA-capable spectrum viewer). However it is not necessary for SSA to be involved; SSA-like metadata may be faked and used to message loading of a spectrum from any source. In the latter case it is RECOMMENDED to provide at least theAccess.Format entry in the meta map.
client.env.getReturns the value of an environment variable present in the environment of the receiver client.
bibcode.loadExchange a bibcode:
voresource.loadlist (and subtypes)Exchange a set of vo registry resources. A registry resource is described by an xml document - a VOResource . Each registry resource is uniquely identified by a IVOID - a uri startingivo://
ids map are a convenience for receivers who may not possess a SOAP Registry client with which to retrieve the voresources themself. The URLs may also be useful in the case where the resource is only available in registry private to the sender, not in a registry known by the receiver.
However, the URL values are not mandatory, because to implement this, it may be necessary for the sender to create a local web-server - which is quite a demand for, say, a trivial script.
If the registry spec ever develops to provide a trival http / rest interface to resources, the URL values could link direct to this - but at the moment it's a work-around for the relative inaccessability of the registry SOAP interface. | ||||||||
Added: | ||||||||
> > |
coverage.load.moc.fitsLoad a Multi-Order Coverage map in FITS format. MOCs and their FITS serialization are described in the MOC standard. FITS is the standard exchange format for MOCs - the introduction of alternative MOC load MTypes is not encouraged.
| |||||||
Experimental Administrative MTypesx-samp.query.by-metaQueries which clients are currently registered with a given metadata value. A typical use would be to query which client(s) is currently registered with a givensamp.name , so for instance you could find the client ID of a registered Aladin instance
by calling this MType with key="samp.name" and value="Aladin".
This is effectively a convenience method for interrogating the metadata currently available
from the Hub, and so could typically be implemented by the Hub,
but there is nothing to stop a client from implementing it too.
|
SAMP MTypesThis page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients.IntroductionAn MType (Message Type) is the semantic label attached to a SAMP message (see SampInfo). An MType is a string which looks syntactically likea.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard.
MTypes fall into (about) three categories: | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines: | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
The intention is that application MTypes, once added to this list, will continue to be used for the purpose for which they were introduced rather than being replaced by other differently-named ones of similar purpose. There may be amendments which involve addition of optional parameters or return values, on the understanding that they do not invalidate messages exchanged without knowledge of the new additions. In this way backward compatibility should be maintained.
This procedure is currently quite informal. It has worked well to date, but will remain under review. If the SAMP community decides that a change to the procedure is desirable, for instance publication of Application MTypes in an IVOA Note, or more structured review of suggestions, the new policy will be described here. This page may be reorganised at some point, for instance splitting the known Application MTypes into more than one list.
Application MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format. | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > | This is the usual way to exchange table data between SAMP clients.
| |||||||
Added: | ||||||||
> > |
| |||||||
Changed: | ||||||||
< < | table.load.fitsLoads a table in FITS format.
| |||||||
> > | table.load.*Othertable.load variants are permitted for different formats. The parameters and return value are the same as for table.load.votable above, but the resource referenced by the url argument has the appropriate file format.
Variants known to be in use are:
| |||||||
Deleted: | ||||||||
< < |
| |||||||
Added: | ||||||||
> > | Note that clients are not encouraged to proliferate these format-specific MTypes. Where possible, it is recommended to use VOTable for exchange between VO-aware SAMP clients. For general purpose clients it is appropriate to send and receive only table.load.votable and not other table.load.* variants. However, where clients need to exchange tabular data in a particular format, for instance because both ends of the communication are known to understand the format in question, or because the data or metadata are likely to be compromised by conversion to VOTable, use of a different format-specific MType may be appropriate, on the understanding that such communication may not be interoperable with generic table-handling SAMP clients. | |||||||
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application. | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application. | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
image.load.fitsLoads a 2-dimensional FITS image. | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere. | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
spectrum.load.ssa-genericLoads a spectrum or SED. The name refers to the fact that the metadata passed with this MType is based on the Simple Spectral Access protocol, but not on any particular version of it. The arguments are chosen such that it is convenient to use this MType for passing the results of an SSA query from an SSA client to a spectrum viewer (particularly to an SSA-capable spectrum viewer). However it is not necessary for SSA to be involved; SSA-like metadata may be faked and used to message loading of a spectrum from any source. In the latter case it is RECOMMENDED to provide at least theAccess.Format entry in the meta map. | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
client.env.getReturns the value of an environment variable present in the environment of the receiver client. | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
bibcode.loadExchange a bibcode: | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
voresource.loadlist (and subtypes)Exchange a set of vo registry resources. A registry resource is described by an xml document - a VOResource . Each registry resource is uniquely identified by a IVOID - a uri startingivo:// | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
The URL values in the ids map are a convenience for receivers who may not possess a SOAP Registry client with which to retrieve the voresources themself. The URLs may also be useful in the case where the resource is only available in registry private to the sender, not in a registry known by the receiver.
However, the URL values are not mandatory, because to implement this, it may be necessary for the sender to create a local web-server - which is quite a demand for, say, a trivial script.
If the registry spec ever develops to provide a trival http / rest interface to resources, the URL values could link direct to this - but at the moment it's a work-around for the relative inaccessability of the registry SOAP interface.
Experimental Administrative MTypesx-samp.query.by-metaQueries which clients are currently registered with a given metadata value. A typical use would be to query which client(s) is currently registered with a givensamp.name , so for instance you could find the client ID of a registered Aladin instance
by calling this MType with key="samp.name" and value="Aladin".
This is effectively a convenience method for interrogating the metadata currently available
from the Hub, and so could typically be implemented by the Hub,
but there is nothing to stop a client from implementing it too. | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Deleted: | ||||||||
< < |
SAMP MTypesThis page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients.IntroductionAn MType (Message Type) is the semantic label attached to a SAMP message (see SampInfo). An MType is a string which looks syntactically likea.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard.
MTypes fall into (about) three categories:
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines:
Application MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
spectrum.load.ssa-genericLoads a spectrum or SED. The name refers to the fact that the metadata passed with this MType is based on the Simple Spectral Access protocol, but not on any particular version of it. The arguments are chosen such that it is convenient to use this MType for passing the results of an SSA query from an SSA client to a spectrum viewer (particularly to an SSA-capable spectrum viewer). However it is not necessary for SSA to be involved; SSA-like metadata may be faked and used to message loading of a spectrum from any source. In the latter case it is RECOMMENDED to provide at least theAccess.Format entry in the meta map.
client.env.getReturns the value of an environment variable present in the environment of the receiver client.
bibcode.loadExchange a bibcode:
voresource.loadlist (and subtypes)Exchange a set of vo registry resources. A registry resource is described by an xml document - a VOResource . Each registry resource is uniquely identified by a IVOID - a uri startingivo://
ids map are a convenience for receivers who may not possess a SOAP Registry client with which to retrieve the voresources themself. The URLs may also be useful in the case where the resource is only available in registry private to the sender, not in a registry known by the receiver.
However, the URL values are not mandatory, because to implement this, it may be necessary for the sender to create a local web-server - which is quite a demand for, say, a trivial script.
If the registry spec ever develops to provide a trival http / rest interface to resources, the URL values could link direct to this - but at the moment it's a work-around for the relative inaccessability of the registry SOAP interface.
Experimental Administrative MTypesx-samp.query.by-metaQueries which clients are currently registered with a given metadata value. A typical use would be to query which client(s) is currently registered with a givensamp.name , so for instance you could find the client ID of a registered Aladin instance
by calling this MType with key="samp.name" and value="Aladin".
This is effectively a convenience method for interrogating the metadata currently available
from the Hub, and so could typically be implemented by the Hub,
but there is nothing to stop a client from implementing it too.
|
<--
SAMP MTypesThis page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients.IntroductionAn MType (Message Type) is the semantic label attached to a SAMP message (see SampInfo). An MType is a string which looks syntactically likea.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard.
MTypes fall into (about) three categories: | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Added: | ||||||||
> > |
| |||||||
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines:
Application MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
spectrum.load.ssa-genericLoads a spectrum or SED. The name refers to the fact that the metadata passed with this MType is based on the Simple Spectral Access protocol, but not on any particular version of it. The arguments are chosen such that it is convenient to use this MType for passing the results of an SSA query from an SSA client to a spectrum viewer (particularly to an SSA-capable spectrum viewer). However it is not necessary for SSA to be involved; SSA-like metadata may be faked and used to message loading of a spectrum from any source. In the latter case it is RECOMMENDED to provide at least theAccess.Format entry in the meta map.
client.env.getReturns the value of an environment variable present in the environment of the receiver client.
bibcode.loadExchange a bibcode:
voresource.loadlist (and subtypes)Exchange a set of vo registry resources. A registry resource is described by an xml document - a VOResource . Each registry resource is uniquely identified by a IVOID - a uri startingivo://
ids map are a convenience for receivers who may not possess a SOAP Registry client with which to retrieve the voresources themself. The URLs may also be useful in the case where the resource is only available in registry private to the sender, not in a registry known by the receiver.
However, the URL values are not mandatory, because to implement this, it may be necessary for the sender to create a local web-server - which is quite a demand for, say, a trivial script.
If the registry spec ever develops to provide a trival http / rest interface to resources, the URL values could link direct to this - but at the moment it's a work-around for the relative inaccessability of the registry SOAP interface. | ||||||||
Added: | ||||||||
> > |
Experimental Administrative MTypesx-samp.query.by-metaQueries which clients are currently registered with a given metadata value. A typical use would be to query which client(s) is currently registered with a givensamp.name , so for instance you could find the client ID of a registered Aladin instance
by calling this MType with key="samp.name" and value="Aladin".
This is effectively a convenience method for interrogating the metadata currently available
from the Hub, and so could typically be implemented by the Hub,
but there is nothing to stop a client from implementing it too.
| |||||||
<--
SAMP MTypesThis page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients.IntroductionAn MType (Message Type) is the semantic label attached to a SAMP message (see SampInfo). An MType is a string which looks syntactically likea.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard.
MTypes fall into (about) three categories:
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines:
Application MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
spectrum.load.ssa-genericLoads a spectrum or SED. The name refers to the fact that the metadata passed with this MType is based on the Simple Spectral Access protocol, but not on any particular version of it. The arguments are chosen such that it is convenient to use this MType for passing the results of an SSA query from an SSA client to a spectrum viewer (particularly to an SSA-capable spectrum viewer). However it is not necessary for SSA to be involved; SSA-like metadata may be faked and used to message loading of a spectrum from any source. In the latter case it is RECOMMENDED to provide at least theAccess.Format entry in the meta map.
client.env.getReturns the value of an environment variable present in the environment of the receiver client.
bibcode.loadExchange a bibcode:
| ||||||||
Changed: | ||||||||
< < | voresource.loadlist | |||||||
> > | voresource.loadlist (and subtypes) | |||||||
Exchange a set of vo registry resources.
A registry resource is described by an xml document - a VOResource .
Each registry resource is uniquely identified by a IVOID - a uri starting ivo:// | ||||||||
Added: | ||||||||
> > |
| |||||||
ids map are a convenience for receivers who may not possess a SOAP Registry client with which to retrieve the voresources themself. The URLs may also be useful in the case where the resource is only available in registry private to the sender, not in a registry known by the receiver.
However, the URL values are not mandatory, because to implement this, it may be necessary for the sender to create a local web-server - which is quite a demand for, say, a trivial script.
If the registry spec ever develops to provide a trival http / rest interface to resources, the URL values could link direct to this - but at the moment it's a work-around for the relative inaccessability of the registry SOAP interface. |
<--
SAMP MTypesThis page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients.IntroductionAn MType (Message Type) is the semantic label attached to a SAMP message (see SampInfo). An MType is a string which looks syntactically likea.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard.
MTypes fall into (about) three categories:
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines:
Application MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
spectrum.load.ssa-genericLoads a spectrum or SED. The name refers to the fact that the metadata passed with this MType is based on the Simple Spectral Access protocol, but not on any particular version of it. The arguments are chosen such that it is convenient to use this MType for passing the results of an SSA query from an SSA client to a spectrum viewer (particularly to an SSA-capable spectrum viewer). However it is not necessary for SSA to be involved; SSA-like metadata may be faked and used to message loading of a spectrum from any source. In the latter case it is RECOMMENDED to provide at least theAccess.Format entry in the meta map.
client.env.getReturns the value of an environment variable present in the environment of the receiver client.
bibcode.load | ||||||||
Changed: | ||||||||
< < | Exchange a [[http://en.wikipedia.org/wiki/Bibcode] [bibcode]]: | |||||||
> > | Exchange a bibcode: | |||||||
voresource.loadlistExchange a set of vo registry resources. A registry resource is described by an xml document - a VOResource . Each registry resource is uniquely identified by a IVOID - a uri startingivo://
ids map are a convenience for receivers who may not possess a SOAP Registry client with which to retrieve the voresources themself. The URLs may also be useful in the case where the resource is only available in registry private to the sender, not in a registry known by the receiver.
However, the URL values are not mandatory, because to implement this, it may be necessary for the sender to create a local web-server - which is quite a demand for, say, a trivial script.
If the registry spec ever develops to provide a trival http / rest interface to resources, the URL values could link direct to this - but at the moment it's a work-around for the relative inaccessability of the registry SOAP interface. |
<--
SAMP MTypesThis page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients.IntroductionAn MType (Message Type) is the semantic label attached to a SAMP message (see SampInfo). An MType is a string which looks syntactically likea.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard.
MTypes fall into (about) three categories:
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines:
Application MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
spectrum.load.ssa-genericLoads a spectrum or SED. The name refers to the fact that the metadata passed with this MType is based on the Simple Spectral Access protocol, but not on any particular version of it. The arguments are chosen such that it is convenient to use this MType for passing the results of an SSA query from an SSA client to a spectrum viewer (particularly to an SSA-capable spectrum viewer). However it is not necessary for SSA to be involved; SSA-like metadata may be faked and used to message loading of a spectrum from any source. In the latter case it is RECOMMENDED to provide at least theAccess.Format entry in the meta map.
client.env.getReturns the value of an environment variable present in the environment of the receiver client.
| ||||||||
Added: | ||||||||
> > |
bibcode.loadExchange a [[http://en.wikipedia.org/wiki/Bibcode] [bibcode]]:
voresource.loadlistExchange a set of vo registry resources. A registry resource is described by an xml document - a VOResource . Each registry resource is uniquely identified by a IVOID - a uri startingivo://
ids map are a convenience for receivers who may not possess a SOAP Registry client with which to retrieve the voresources themself. The URLs may also be useful in the case where the resource is only available in registry private to the sender, not in a registry known by the receiver.
However, the URL values are not mandatory, because to implement this, it may be necessary for the sender to create a local web-server - which is quite a demand for, say, a trivial script.
If the registry spec ever develops to provide a trival http / rest interface to resources, the URL values could link direct to this - but at the moment it's a work-around for the relative inaccessability of the registry SOAP interface. | |||||||
<--
SAMP MTypesThis page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients.IntroductionAn MType (Message Type) is the semantic label attached to a SAMP message (see SampInfo). An MType is a string which looks syntactically likea.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard.
MTypes fall into (about) three categories:
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines:
Application MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
spectrum.load.ssa-genericLoads a spectrum or SED. The name refers to the fact that the metadata passed with this MType is based on the Simple Spectral Access protocol, but not on any particular version of it. The arguments are chosen such that it is convenient to use this MType for passing the results of an SSA query from an SSA client to a spectrum viewer (particularly to an SSA-capable spectrum viewer). However it is not necessary for SSA to be involved; SSA-like metadata may be faked and used to message loading of a spectrum from any source. In the latter case it is RECOMMENDED to provide at least theAccess.Format entry in the meta map.
| ||||||||
Added: | ||||||||
> > |
client.env.getReturns the value of an environment variable present in the environment of the receiver client.
| |||||||
<--
SAMP MTypesThis page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients.IntroductionAn MType (Message Type) is the semantic label attached to a SAMP message (see SampInfo). An MType is a string which looks syntactically likea.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard.
MTypes fall into (about) three categories:
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines:
Application MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
| ||||||||
Added: | ||||||||
> > |
spectrum.load.ssa-genericLoads a spectrum or SED. The name refers to the fact that the metadata passed with this MType is based on the Simple Spectral Access protocol, but not on any particular version of it. The arguments are chosen such that it is convenient to use this MType for passing the results of an SSA query from an SSA client to a spectrum viewer (particularly to an SSA-capable spectrum viewer). However it is not necessary for SSA to be involved; SSA-like metadata may be faked and used to message loading of a spectrum from any source. In the latter case it is RECOMMENDED to provide at least theAccess.Format entry in the meta map.
| |||||||
|
<--
SAMP MTypesThis page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients.IntroductionAn MType (Message Type) is the semantic label attached to a SAMP message (see SampInfo). An MType is a string which looks syntactically likea.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard.
MTypes fall into (about) three categories:
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines:
| ||||||||
Changed: | ||||||||
< < | This procedure is currently quite informal. It has worked well to date, but will remain under review. If the SAMP community decides that a change to the procedure is desirable, for instance publication of Application MTypes in an IVOA Note, or more structured review of suggestions, the new policy will be described here. | |||||||
> > | This procedure is currently quite informal. It has worked well to date, but will remain under review. If the SAMP community decides that a change to the procedure is desirable, for instance publication of Application MTypes in an IVOA Note, or more structured review of suggestions, the new policy will be described here. This page may be reorganised at some point, for instance splitting the known Application MTypes into more than one list. | |||||||
Application MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
|
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
<--
SAMP MTypesThis page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients.Introduction | ||||||||
Changed: | ||||||||
< < | An MType (Message Type) is the semantic label attached to a SAMP message (see SampProgress). An MType is a string which looks syntactically like a.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard. | |||||||
> > | An MType (Message Type) is the semantic label attached to a SAMP message (see SampInfo). An MType is a string which looks syntactically like a.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard. | |||||||
MTypes fall into (about) three categories:
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines:
Application MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
|
<--
SAMP MTypes | ||||||||
Added: | ||||||||
> > | This page discusses SAMP MTypes. MTypes define the semantics of messages exchanged between SAMP clients. | |||||||
Changed: | ||||||||
< < | This page lists MTypes currently in use by applications which implement SAMP (beyond that small number of administrative MTypes currently defined in the SAMP document). It may at some point be formalised into an IVOA Note. | |||||||
> > | Introduction | |||||||
Changed: | ||||||||
< < | The items listed here are a work in progress, and may be revised, replaced or removed in the future. Discussion of the content on this page is best done on the apps-samp mailing list. | |||||||
> > | An MType (Message Type) is the semantic label attached to a SAMP message (see SampProgress). An MType is a string which looks syntactically like a.b.c , and it has associated named parameters and return values - it can be thought of as a bit like a subroutine definition. More detailed and definitive discussion of MType syntax and usage can be found in the SAMP Standard. | |||||||
Changed: | ||||||||
< < | Application domain MTypes | |||||||
> > | MTypes fall into (about) three categories: | |||||||
Added: | ||||||||
> > |
| |||||||
Added: | ||||||||
> > |
ProcessAn application author who needs to exchange an application-type message with particular semantics should proceed along the following lines:
Application MTypes | |||||||
The following MTypes are ones which application authors are using, or are considering using.
table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
| ||||||||
Deleted: | ||||||||
< < |
Administrative MTypesThe following MTypes are ones which have been proposed for addition to the SAMP standard as administrative MTypes. If people agree, they will be added to the next version of the SAMP draft.
| |||||||
<--
SAMP MTypesThis page lists MTypes currently in use by applications which implement SAMP (beyond that small number of administrative MTypes currently defined in the SAMP document). It may at some point be formalised into an IVOA Note. The items listed here are a work in progress, and may be revised, replaced or removed in the future. Discussion of the content on this page is best done on theapps-samp mailing list.
Application domain MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
Administrative MTypesThe following MTypes are ones which have been proposed for addition to the SAMP standard as administrative MTypes. If people agree, they will be added to the next version of the SAMP draft. | ||||||||
Changed: | ||||||||
< < | samp.hub.disconnect | |||||||
> > |
| |||||||
Deleted: | ||||||||
< < | Sent by the hub to a client if the hub intends to disconnect the client forcibly. This indicates that no further communication from that client is welcome, and any such attempts may be expected to fail. The hub may wish to disconnect clients forcibly as a result of some hub timeout policy or for other reasons.
| |||||||
<--
SAMP MTypesThis page lists MTypes currently in use by applications which implement SAMP (beyond that small number of administrative MTypes currently defined in the SAMP document). It may at some point be formalised into an IVOA Note. The items listed here are a work in progress, and may be revised, replaced or removed in the future. Discussion of the content on this page is best done on theapps-samp mailing list.
Application domain MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format.
| ||||||||
Added: | ||||||||
> > |
| |||||||
table.load.fitsLoads a table in FITS format.
| ||||||||
Added: | ||||||||
> > |
| |||||||
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
| ||||||||
Added: | ||||||||
> > |
| |||||||
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
Administrative MTypesThe following MTypes are ones which have been proposed for addition to the SAMP standard as administrative MTypes. If people agree, they will be added to the next version of the SAMP draft.samp.hub.disconnectSent by the hub to a client if the hub intends to disconnect the client forcibly. This indicates that no further communication from that client is welcome, and any such attempts may be expected to fail. The hub may wish to disconnect clients forcibly as a result of some hub timeout policy or for other reasons.
|
<--
SAMP MTypesThis page lists MTypes currently in use by applications which implement SAMP (beyond that small number of administrative MTypes currently defined in the SAMP document). It may at some point be formalised into an IVOA Note. The items listed here are a work in progress, and may be revised, replaced or removed in the future. Discussion of the content on this page is best done on theapps-samp mailing list.
Application domain MTypesThe following MTypes are ones which application authors are using, or are considering using.table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
| ||||||||
Added: | ||||||||
> > |
coord.pointAt.skyDirects attention (e.g. by moving a cursor or shifting the field of view) to a given point on the celestial sphere.
| |||||||
Administrative MTypesThe following MTypes are ones which have been proposed for addition to the SAMP standard as administrative MTypes. If people agree, they will be added to the next version of the SAMP draft.samp.hub.disconnectSent by the hub to a client if the hub intends to disconnect the client forcibly. This indicates that no further communication from that client is welcome, and any such attempts may be expected to fail. The hub may wish to disconnect clients forcibly as a result of some hub timeout policy or for other reasons.
|
<--
SAMP MTypes | ||||||||
Changed: | ||||||||
< < | This page lists MTypes currently in use by applications which implement SAMP (beyond that small number of administrative MTypes defined in the SAMP document). It may at some point be formalised into an IVOA Note. | |||||||
> > | This page lists MTypes currently in use by applications which implement SAMP (beyond that small number of administrative MTypes currently defined in the SAMP document). It may at some point be formalised into an IVOA Note. | |||||||
The items listed here are a work in progress, and may be revised, replaced or removed in the future. Discussion of the content on this page is best done on the apps-samp mailing list. | ||||||||
Changed: | ||||||||
< < | table.load.votable | |||||||
> > | Application domain MTypes | |||||||
Added: | ||||||||
> > |
The following MTypes are ones which application authors are using, or are considering using.
table.load.votable | |||||||
Loads a table in VOTable format.
| ||||||||
Changed: | ||||||||
< < | table.load.fits | |||||||
> > | table.load.fits | |||||||
Loads a table in FITS format.
| ||||||||
Changed: | ||||||||
< < | table.highlight.row | |||||||
> > | table.highlight.row | |||||||
Highlights a single row of an identified table by row index. The table to operate on is identified by one or both of the table-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
| ||||||||
Changed: | ||||||||
< < | table.select.rowList | |||||||
> > | table.select.rowList | |||||||
Selects a list of rows of an identified table by row index. The table to operate on is identified by one or both of the table-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Changed: | ||||||||
< < | image.load.fits | |||||||
> > | image.load.fits | |||||||
Loads a 2-dimensional FITS image.
| ||||||||
Added: | ||||||||
> > |
Administrative MTypesThe following MTypes are ones which have been proposed for addition to the SAMP standard as administrative MTypes. If people agree, they will be added to the next version of the SAMP draft.samp.hub.disconnectSent by the hub to a client if the hub intends to disconnect the client forcibly. This indicates that no further communication from that client is welcome, and any such attempts may be expected to fail. The hub may wish to disconnect clients forcibly as a result of some hub timeout policy or for other reasons.
| |||||||
| ||||||||
Deleted: | ||||||||
< < | ||||||||
<--
| ||||||||
Deleted: | ||||||||
< < | ||||||||
SAMP MTypes | ||||||||
Added: | ||||||||
> > | ||||||||
This page lists MTypes currently in use by applications which implement SAMP (beyond that small number of administrative MTypes defined in the SAMP document). It may at some point be formalised into an IVOA Note.
The items listed here are a work in progress, and may be revised, replaced or removed in the future. Discussion of the content on this page is best done on the apps-samp mailing list.
table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
|
<--
SAMP MTypesThis page lists MTypes currently in use by applications which implement SAMP (beyond that small number of administrative MTypes defined in the SAMP document). It may at some point be formalised into an IVOA Note. The items listed here are a work in progress, and may be revised, replaced or removed in the future. Discussion of the content on this page is best done on theapps-samp mailing list.
table.load.votableLoads a table in VOTable format.
table.load.fitsLoads a table in FITS format.
table.highlight.rowHighlights a single row of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what highlighting means is left to the receiving application.
table.select.rowListSelects a list of rows of an identified table by row index. The table to operate on is identified by one or both of thetable-id or url arguments. At least one of these must be supplied; if both are given they should refer to the same thing. Exactly what selection means is left to the receiving application.
image.load.fitsLoads a 2-dimensional FITS image.
|