Difference between revisions of "Human2opspec.m"
(→See also) |
|||
| Line 5: | Line 5: | ||
The function supports three types of syntax: | The function supports three types of syntax: | ||
| − | 1. If both inputs are strings | + | '''1. If both inputs are strings''' |
[opspecs,coeffs]=human2opspec(spin_system,'Lz','13C') | [opspecs,coeffs]=human2opspec(spin_system,'Lz','13C') | ||
| − | the function returns a list of single-spin opspecs for all spins with the specified name. In the example above, the list of Lz operator specifications for all 13C nuclei in the system would be returned. Valid labels for operators in this type of call are 'E', 'Lz', 'L+', 'L-' and 'Tl,m' | + | the function returns a list of single-spin opspecs for all spins with the specified name. In the example above, the list of Lz operator specifications for all 13C nuclei in the system would be returned. Valid labels for operators in this type of call are 'E' (identity), 'Lz', 'Lx', 'Ly', 'L+', 'L-', and 'Tl,m' (irreducible spherical tensor, l and m are integers). Valid labels for the spins are standard isotope names as well as 'electrons', 'nuclei', and 'all'. |
| − | 2. If one input is a string and the other is a vector | + | '''2. If one input is a string and the other is a vector''' |
[opspecs,coeffs]=human2opspec(spin_system,'Lz',[1 2 4]) | [opspecs,coeffs]=human2opspec(spin_system,'Lz',[1 2 4]) | ||
| − | the function returns a list of single-spin opspecs for all spins with the specified number. In the example above, the list of Lz operator specifications for all 13C nuclei in the system would be returned. Valid labels for operators | + | the function returns a list of single-spin opspecs for all spins with the specified number. In the example above, the list of Lz operator specifications for all 13C nuclei in the system would be returned. Valid labels for operators are the same as in Item 1 above. |
| − | 3. If the two inputs are a cell array of strings and a cell array of numbers | + | '''3. If the two inputs are a cell array of strings and a cell array of numbers''' |
| − | [opspecs,coeffs]=human2opspec(spin_system,{'Lz',' | + | [opspecs,coeffs]=human2opspec(spin_system,{'Lz','Ly'},{1,2}) |
| − | would return the Lz(x) | + | would return the Lz(x)Ly product operator specification with Lz on spin 1 and Ly on spin 2. Valid labels for operators are the same as in Item 1. |
==Outputs== | ==Outputs== | ||
| − | opspecs - | + | opspecs - Spinach operator specification: a cell array of |
row vectors specifying which operator enters the | row vectors specifying which operator enters the | ||
Kronecker product for which spin. | Kronecker product for which spin. | ||
Revision as of 15:34, 28 July 2023
Converts user-friendly descriptions of spin states and operators into the formal operator and state description used by Spinach kernel.
Syntax
The function supports three types of syntax:
1. If both inputs are strings
[opspecs,coeffs]=human2opspec(spin_system,'Lz','13C')
the function returns a list of single-spin opspecs for all spins with the specified name. In the example above, the list of Lz operator specifications for all 13C nuclei in the system would be returned. Valid labels for operators in this type of call are 'E' (identity), 'Lz', 'Lx', 'Ly', 'L+', 'L-', and 'Tl,m' (irreducible spherical tensor, l and m are integers). Valid labels for the spins are standard isotope names as well as 'electrons', 'nuclei', and 'all'.
2. If one input is a string and the other is a vector
[opspecs,coeffs]=human2opspec(spin_system,'Lz',[1 2 4])
the function returns a list of single-spin opspecs for all spins with the specified number. In the example above, the list of Lz operator specifications for all 13C nuclei in the system would be returned. Valid labels for operators are the same as in Item 1 above.
3. If the two inputs are a cell array of strings and a cell array of numbers
[opspecs,coeffs]=human2opspec(spin_system,{'Lz','Ly'},{1,2})
would return the Lz(x)Ly product operator specification with Lz on spin 1 and Ly on spin 2. Valid labels for operators are the same as in Item 1.
Outputs
opspecs - Spinach operator specification: a cell array of
row vectors specifying which operator enters the
Kronecker product for which spin.
coeffs - coefficient with which each of the Kronecker pro-
ducts enters the overall sum.
Notes
Direct calls to this function should not be necessary, use operator.m and state.m functions instead.
See also
operator.m, state.m, equilibrium.m, coherence.m, correlation.m, singlet.m
Version 2.8, authors: Luke Edwards, Ilya Kuprov
