fix opposite axis

Author: ytdHuang

docs/make.jl

@@ -18,8 +18,8 @@ end
 DocMeta.setdocmeta!(QuantumToolbox, :DocTestSetup, doctest_setup; recursive = true)
 
 # some options for `makedocs`
-const DRAFT = get(ENV, "DRAFT", false) == "true"  # set `true`  to disable cell evaluation
-const DOCTEST = get(ENV, "DOCTEST", true) == "true" # set `false` to skip doc tests
+const DRAFT = get(ENV, "DRAFT", false) == true     # set `true`  to disable cell evaluation
+const DOCTEST = get(ENV, "DOCTEST", true) == false # set `false` to skip doc tests
 
 # generate bibliography
 bib = CitationBibliography(

docs/src/users_guide/plotting_the_bloch_sphere.md

@@ -65,7 +65,7 @@ fig
 
 ## Add multiple data
 
-We can also plot multiple points, vectors, and states at the same time by passing arrays instead of individual elements via [`add_points!](@ref), [`add_vectors!](@ref), and [`add_states!](@ref), respectively. Before giving an example, we can use [`clear!`](@ref) to remove the current data from our [`Bloch`](@ref) sphere instead of creating a new instance:
+We can also plot multiple points, vectors, and states at the same time by passing arrays instead of individual elements via [`add_points!`](@ref), [`add_vectors!`](@ref), and [`add_states!`](@ref), respectively. Before giving an example, we can use [`clear!`](@ref) to remove the current data from our [`Bloch`](@ref) sphere instead of creating a new instance:
 
 ```@example Bloch_sphere_rendering
 clear!(b)
@@ -77,7 +77,7 @@ Now on the same [`Bloch`](@ref) sphere, we can plot the three states via [`add_s
 
 ```@example Bloch_sphere_rendering
 x = basis(2, 0) + basis(2, 1)
-y = basis(2, 0) - im * basis(2, 1)
+y = basis(2, 0) + im * basis(2, 1)
 z = basis(2, 0)
 add_states!(b, [x, y, z])
 fig, _ = render(b)
@@ -175,7 +175,7 @@ At the end of the last section we saw that the colors and marker shapes of the d
 | `b.font_size` | Font size for labels | `15` |
 | `b.frame_alpha` | Transparency of the frame background | `0.1` |
 | `b.frame_color` | Background color of the frame | `"gray"` |
-| `b.frame_limit` | Axis limits for the 3D frame (symmetric around origin) | `1.14` |
+| `b.frame_limit` | Axis limits for the 3D frame (symmetric around origin) | `1.2` |
 | `b.point_default_color` | Default color cycle for points | `["blue", "red", "green", "#CC6600"]` |
 | `b.point_color` | List of colors for Bloch point markers to cycle through | `Union{Nothing,String}[]` |
 | `b.point_marker` | List of point marker shapes to cycle through | `[:circle, :rect, :diamond, :utriangle]` |
@@ -186,14 +186,14 @@ At the end of the last section we saw that the colors and marker shapes of the d
 | `b.sphere_alpha` | Transparency of sphere surface | `"#FFDDDD"` |
 | `b.vector_color` | Colors for vectors | `["green", "#CC6600", "blue", "red"]` |
 | `b.vector_width` | Width of vectors | `0.025` |
-| `b.vector_arrowsize` | Arrow size parameters as (head length, head width, stem width) | `(0.07, 0.08, 0.08)` |
-| `b.view` | Azimuthal and elevation viewing angles in degrees | `(-60, 30)` |
-| `b.xlabel` | Labels for x-axis | `(L"x", "")` |
-| `b.xlpos` | Positions of x-axis labels | `(1.0, -1.0)` |
-| `b.ylabel` | Labels for y-axis | `(L"y", "")` |
-| `b.ylpos` | Positions of y-axis labels | `(1.0, -1.0)` |
-| `b.zlabel` | Labels for z-axis | `(L"\|0\rangle", L"\|1\rangle)"` |
-| `b.zlpos` | Positions of z-axis labels | `(1.0, -1.0)` |
+| `b.vector_arrowsize` | Arrow size parameters as (head length, head width, stem width) | `[0.07, 0.08, 0.08]` |
+| `b.view` | Azimuthal and elevation viewing angles in degrees | `[30, 30]` |
+| `b.xlabel` | Labels for x-axis | `[L"x", ""]` (``+x`` and ``-x``) |
+| `b.xlpos` | Positions of x-axis labels | `[1.0, -1.0]` |
+| `b.ylabel` | Labels for y-axis | `[L"y", ""]` (``+y`` and ``-y``) |
+| `b.ylpos` | Positions of y-axis labels | `[1.0, -1.0]` |
+| `b.zlabel` | Labels for z-axis | `[L"\|0\rangle", L"\|1\rangle]"` (``+z`` and ``-z``) |
+| `b.zlpos` | Positions of z-axis labels | `[1.0, -1.0]` |
 
 These properties can also be accessed via the `print` command:
 

ext/QuantumToolboxMakieExt.jl

@@ -398,8 +398,10 @@ function _setup_bloch_plot!(b::Bloch, location)
         yspinesvisible = false,
         zspinesvisible = false,
         protrusions = (0, 0, 0, 0),
+        perspectiveness = 0.2,
         viewmode = :fit,
     )
+    length(b.view) == 2 || throw(ArgumentError("The length of `Bloch.view` must be 2."))
     ax.azimuth[] = deg2rad(b.view[1])
     ax.elevation[] = deg2rad(b.view[2])
     return fig, ax
@@ -452,9 +454,9 @@ function _draw_reference_circles!(ax)
     φ = range(0, 2π, length = 100)
     # XY, YZ, XZ circles
     circles = [
-        [Point3f(sin(φi), -cos(φi), 0) for φi in φ],  # XY
-        [Point3f(0, -cos(φi), sin(φi)) for φi in φ],  # YZ
-        [Point3f(sin(φi), 0, cos(φi)) for φi in φ],   # XZ
+        [Point3f(cos(φi), sin(φi), 0) for φi in φ],  # XY
+        [Point3f(0, cos(φi), sin(φi)) for φi in φ],  # YZ
+        [Point3f(cos(φi), 0, sin(φi)) for φi in φ],  # XZ
     ]
     for circle in circles
         lines!(ax, circle; color = wire_color, linewidth = 1.0)
@@ -475,9 +477,9 @@ function _draw_axes!(ax)
     axis_color = RGBAf(0.3, 0.3, 0.3, 0.8)
     axis_width = 0.8
     axes = [
-        ([Point3f(0, -1.0, 0), Point3f(0, 1.0, 0)], "y"),  # Y-axis
-        ([Point3f(-1.0, 0, 0), Point3f(1.0, 0, 0)], "x"),  # X-axis
-        ([Point3f(0, 0, -1.0), Point3f(0, 0, 1.0)], "z"),  # Z-axis
+        ([Point3f(1.0, 0, 0), Point3f(-1.0, 0, 0)], "x"),  # X-axis
+        ([Point3f(0, 1.0, 0), Point3f(0, -1.0, 0)], "y"),  # Y-axis
+        ([Point3f(0, 0, 1.0), Point3f(0, 0, -1.0)], "z"),  # Z-axis
     ]
     for (points, _) in axes
         lines!(ax, points; color = axis_color, linewidth = axis_width)
@@ -503,8 +505,8 @@ function _plot_points!(b::Bloch, ax)
         marker = b.point_marker[mod1(k, length(b.point_marker))]
         N = size(pts, 2)
 
-        raw_x = pts[2, :]
-        raw_y = -pts[1, :]
+        raw_x = pts[1, :]
+        raw_y = pts[2, :]
         raw_z = pts[3, :]
 
         ds = vec(sqrt.(sum(abs2, pts; dims = 1)))
@@ -607,10 +609,10 @@ function _plot_arcs!(b::Bloch, ax)
         θ = acos(clamp(dot(v1, v2), -1.0, 1.0))
         if length(arc_pts) == 3
             vm = normalize(arc_pts[2])
-            dot(cross(v1, vm), n) < 0 && (θ = 2π - θ)
+            dot(cross(v1, vm), n) < 0 && (θ -= 2π)
         end
         t_range = range(0, θ, length = 100)
-        arc_points = [Point3f((v1*cos(t) + cross(n, v1)*sin(t))...) for t in t_range]
+        arc_points = [Point3f((v1 * cos(t) + cross(n, v1) * sin(t))) for t in t_range]
         lines!(ax, arc_points; color = RGBAf(0.8, 0.4, 0.1, 0.9), linewidth = 2.0, linestyle = :solid)
     end
 end
@@ -632,7 +634,7 @@ function _plot_vectors!(b::Bloch, ax)
     r = 1.0
     for (i, v) in enumerate(b.vectors)
         color = get(b.vector_color, i, RGBAf(0.2, 0.5, 0.8, 0.9))
-        vec = Vec3f(v[2], -v[1], v[3])
+        vec = Vec3f(v...)
         length = norm(vec)
         max_length = r * 0.90
         vec = length > max_length ? (vec/length) * max_length : vec
@@ -660,69 +662,66 @@ Add axis labels and state labels to the Bloch sphere.
 Positions standard labels `(x, y, |0⟩, |1⟩)` at appropriate locations.
 """
 function _add_labels!(b::Bloch, ax)
+    length(b.xlabel) == 2 || throw(ArgumentError("The length of `Bloch.xlabel` must be 2."))
+    length(b.ylabel) == 2 || throw(ArgumentError("The length of `Bloch.ylabel` must be 2."))
+    length(b.zlabel) == 2 || throw(ArgumentError("The length of `Bloch.zlabel` must be 2."))
+    length(b.xlpos) == 2 || throw(ArgumentError("The length of `Bloch.xlpos` must be 2."))
+    length(b.ylpos) == 2 || throw(ArgumentError("The length of `Bloch.ylpos` must be 2."))
+    length(b.zlpos) == 2 || throw(ArgumentError("The length of `Bloch.zlpos` must be 2."))
+
     label_color = parse(RGBf, b.font_color)
     label_size = b.font_size
     offset_scale = b.frame_limit
-    if b.xlabel[1] != ""
-        text!(
-            ax,
-            b.xlabel[1],
-            position = Point3f(0, -offset_scale * b.xlpos[1], 0),
-            color = label_color,
-            fontsize = label_size,
-            align = (:center, :center),
-        )
-    end
-    if b.xlabel[2] != ""
-        text!(
-            ax,
-            b.xlabel[2],
-            position = Point3f(0, -offset_scale * b.xlpos[2], 0),
-            color = label_color,
-            fontsize = label_size,
-            align = (:center, :center),
-        )
-    end
-    if b.ylabel[1] != ""
-        text!(
-            ax,
-            b.ylabel[1],
-            position = Point3f(offset_scale * b.ylpos[1], 0, 0),
-            color = label_color,
-            fontsize = label_size,
-            align = (:center, :center),
-        )
-    end
-    if b.ylabel[2] != ""
-        text!(
-            ax,
-            b.ylabel[2],
-            position = Point3f(offset_scale * b.ylpos[2], 0, 0),
-            color = label_color,
-            fontsize = label_size,
-            align = (:center, :center),
-        )
-    end
-    if b.zlabel[1] != ""
-        text!(
-            ax,
-            b.zlabel[1],
-            position = Point3f(0, 0, offset_scale * b.zlpos[1]),
-            color = label_color,
-            fontsize = label_size,
-            align = (:center, :center),
-        )
-    end
-    if b.zlabel[2] != ""
-        text!(
-            ax,
-            b.zlabel[2],
-            position = Point3f(0, 0, offset_scale * b.zlpos[2]),
-            color = label_color,
-            fontsize = label_size,
-            align = (:center, :center),
-        )
-    end
+
+    (b.xlabel[1] == "") || text!(
+        ax,
+        b.xlabel[1],
+        position = Point3f(offset_scale * b.xlpos[1], 0, 0),
+        color = label_color,
+        fontsize = label_size,
+        align = (:center, :center),
+    )
+    (b.xlabel[2] == "") || text!(
+        ax,
+        b.xlabel[2],
+        position = Point3f(offset_scale * b.xlpos[2], 0, 0),
+        color = label_color,
+        fontsize = label_size,
+        align = (:center, :center),
+    )
+    (b.ylabel[1] == "") || text!(
+        ax,
+        b.ylabel[1],
+        position = Point3f(0, offset_scale * b.ylpos[1], 0),
+        color = label_color,
+        fontsize = label_size,
+        align = (:center, :center),
+    )
+    (b.ylabel[2] == "") || text!(
+        ax,
+        b.ylabel[2],
+        position = Point3f(0, offset_scale * b.ylpos[2], 0),
+        color = label_color,
+        fontsize = label_size,
+        align = (:center, :center),
+    )
+    (b.zlabel[1] == "") || text!(
+        ax,
+        b.zlabel[1],
+        position = Point3f(0, 0, offset_scale * b.zlpos[1]),
+        color = label_color,
+        fontsize = label_size,
+        align = (:center, :center),
+    )
+    (b.zlabel[2] == "") || text!(
+        ax,
+        b.zlabel[2],
+        position = Point3f(0, 0, offset_scale * b.zlpos[2]),
+        color = label_color,
+        fontsize = label_size,
+        align = (:center, :center),
+    )
+    return nothing
 end
 
 @doc raw"""

src/visualization.jl

@@ -103,19 +103,19 @@ A structure representing a Bloch sphere visualization for quantum states.
 
 - `vector_color`::Vector{String}: Colors for vectors
 - `vector_width`::Float64: Width of vectors
-- `vector_arrowsize`::NTuple{3, Real}: Arrow size parameters as (head length, head width, stem width)
+- `vector_arrowsize`::Vector{Float64}: Arrow size parameters as [head length, head width, stem width]
 
 ## Layout properties
 
-- `view::Tuple{Int,Int}}`: Azimuthal and elevation viewing angles in degrees. Default: `(-60, 30)`
+- `view::Vector{Int}`: Azimuthal and elevation viewing angles in degrees. Default: `[30, 30]`
 
 ## Label properties
-- `xlabel::Tuple{AbstractString,AbstractString}`: Labels for x-axis. Default: `(L"x", "")`
-- `xlpos::Tuple{Float64,Float64}`: Positions of x-axis labels. Default: `(1.0, -1.0)`
-- `ylabel::Tuple{AbstractString,AbstractString}`: Labels for y-axis. Default: `(L"y", "")`
-- `ylpos::Tuple{Float64,Float64}`: Positions of y-axis labels. Default: `(1.0, -1.0)`
-- `zlabel::Tuple{AbstractString,AbstractString}`: Labels for z-axis. Default: `(L"|0\rangle", L"|1\rangle")`
-- `zlpos::Tuple{Float64,Float64}`: Positions of z-axis labels. Default: `(1.0, -1.0)`
+- `xlabel::Vector{AbstractString}`: Labels for x-axis. Default: `[L"x", ""]`
+- `xlpos::Vector{Float64}`: Positions of x-axis labels. Default: `[1.0, -1.0]`
+- `ylabel::Vector{AbstractString}`: Labels for y-axis. Default: `[L"y", ""]`
+- `ylpos::Vector{Float64}`: Positions of y-axis labels. Default: `[1.0, -1.0]`
+- `zlabel::Vector{AbstractString}`: Labels for z-axis. Default: `[L"|0\rangle", L"|1\rangle"]`
+- `zlpos::Vector{Float64}`: Positions of z-axis labels. Default: `[1.0, -1.0]`
 """
 @kwdef mutable struct Bloch
     points::Vector{Matrix{Float64}} = Vector{Matrix{Float64}}()
@@ -126,7 +126,7 @@ A structure representing a Bloch sphere visualization for quantum states.
     font_size::Int = 15
     frame_alpha::Float64 = 0.1
     frame_color::String = "gray"
-    frame_limit::Float64 = 1.14
+    frame_limit::Float64 = 1.2
     point_default_color::Vector{String} = ["blue", "red", "green", "#CC6600"]
     point_color::Vector{Union{Nothing,String}} = Union{Nothing,String}[]
     point_marker::Vector{Symbol} = [:circle, :rect, :diamond, :utriangle]
@@ -137,14 +137,14 @@ A structure representing a Bloch sphere visualization for quantum states.
     sphere_color::String = "#FFDDDD"
     vector_color::Vector{String} = ["green", "#CC6600", "blue", "red"]
     vector_width::Float64 = 0.025
-    vector_arrowsize::NTuple{3,Real} = (0.07, 0.08, 0.08)
-    view::Tuple{Int,Int} = (-60, 30)
-    xlabel::Tuple{AbstractString,AbstractString} = (L"x", "")
-    xlpos::Tuple{Float64,Float64} = (1.0, -1.0)
-    ylabel::Tuple{AbstractString,AbstractString} = (L"y", "")
-    ylpos::Tuple{Float64,Float64} = (1.0, -1.0)
-    zlabel::Tuple{AbstractString,AbstractString} = (L"|0\rangle", L"|1\rangle")
-    zlpos::Tuple{Float64,Float64} = (1.0, -1.0)
+    vector_arrowsize::Vector{Float64} = [0.07, 0.08, 0.08]
+    view::Vector{Int} = [30, 30]
+    xlabel::Vector{AbstractString} = [L"x", ""]
+    xlpos::Vector{Float64} = [1.0, -1.0]
+    ylabel::Vector{AbstractString} = [L"y", ""]
+    ylpos::Vector{Float64} = [1.0, -1.0]
+    zlabel::Vector{AbstractString} = [L"|0\rangle", L"|1\rangle"]
+    zlpos::Vector{Float64} = [1.0, -1.0]
 end
 
 const BLOCH_DATA_FIELDS = (:points, :vectors, :lines, :arcs)
@@ -260,10 +260,10 @@ Add a line between two points on the Bloch sphere.
 """
 function add_line!(b::Bloch, p1::Vector{<:Real}, p2::Vector{<:Real}; fmt = "k")
     (length(p1) != 3 || length(p2) != 3) && throw(ArgumentError("Points must be 3D vectors"))
-    x = [p1[2], p2[2]]
-    y = [-p1[1], -p2[1]]
+    x = [p1[1], p2[1]]
+    y = [p1[2], p2[2]]
     z = [p1[3], p2[3]]
-    push!(b.lines, (([x, y, z]), fmt))
+    push!(b.lines, ([x, y, z], fmt))
     return b
 end
 
@@ -443,8 +443,9 @@ function _ket_to_bloch(state::QuantumObject{Ket})
         ψ = state.data
     end
 
-    x = 2 * real(ψ[1] * conj(ψ[2]))
-    y = 2 * imag(ψ[1] * conj(ψ[2]))
+    c = conj(ψ[1]) * ψ[2]
+    x = 2 * real(c)
+    y = 2 * imag(c)
     z = abs2(ψ[1]) - abs2(ψ[2])
     return [x, y, z]
 end

test/ext-test/cpu/makie/makie_ext.jl

@@ -160,15 +160,22 @@ end
         @test false
         @info "Render threw unexpected error" exception=e
     end
+
+    # test `state to Bloch vector` conversion and `add_states!` function
     b = Bloch()
-    add_states!(b, basis(2, 0))
-    x = normalize!(basis(2, 0) + basis(2, 1)) # normalized
-    y = basis(2, 0) - im * basis(2, 1)        # unnormalized Ket
+    Pauli_Ops = [sigmax(), sigmay(), sigmaz()]
+    ψ = rand_ket(2)
+    ρ = rand_dm(2)
+    x = basis(2, 0) + basis(2, 1)             # unnormalized Ket
     ρ1 = 0.3 * rand_dm(2) + 0.4 * rand_dm(2)  # unnormalized density operator
     ρ2 = Qobj(rand(ComplexF64, 2, 2))         # unnormalized and non-Hermitian Operator
-    @test_logs (:warn,) (:warn,) (:warn,) (:warn,) add_states!(b, [x, y, ρ1, ρ2])
+    add_states!(b, [ψ, ρ])
+    @test_logs (:warn,) (:warn,) (:warn,) (:warn,) add_states!(b, [x, ρ1, ρ2])
+    @test all(expect(Pauli_Ops, ψ) .≈ (b.vectors[1]))
+    @test all(expect(Pauli_Ops, ρ) .≈ (b.vectors[2]))
     @test length(b.vectors) == 5
-    th = range(0, 2π; length = 20);
+
+    th = range(0, 2π; length = 20)
     xp = cos.(th);
     yp = sin.(th);
     zp = zeros(20);